Hiyve Components - v1.0.0
    Preparing search index...

    Interface HiyveStoreRNOptions

    Configuration options for creating a HiyveStoreRN instance.

    const options: HiyveStoreRNOptions = {
      generateRoomToken: async () => {
        const res = await fetch('/api/token');
        return res.json(); // { roomToken, serverRegionUrl }
      },
      onError: (err) => console.error('Hiyve error:', err.message),
    };
    interface HiyveStoreRNOptions {
        generateRoomToken: () => Promise<
            {
                regions?: string[];
                roomToken: string;
                serverRegion?: string;
                serverRegionUrl: string;
            },
        >;
        onError?: (error: Error) => void;
        storageAdapter?: StorageAdapter;
    }
    Index

    Properties

    generateRoomToken onError? storageAdapter?

    Properties

    generateRoomToken: () => Promise<
        {
            regions?: string[];
            roomToken: string;
            serverRegion?: string;
            serverRegionUrl: string;
        },
    >

    Async function that returns a room token and server connection info.

    Called once each time the store needs to establish a new connection (on HiyveStoreRN.createRoom or HiyveStoreRN.joinRoom).

    Type Declaration

      • (): Promise<
            {
                regions?: string[];
                roomToken: string;
                serverRegion?: string;
                serverRegionUrl: string;
            },
        >

      • Returns Promise<
            {
                regions?: string[];
                roomToken: string;
                serverRegion?: string;
                serverRegionUrl: string;
            },
        >

        An object containing:

        • roomToken -- authentication token for the room
        • serverRegionUrl -- URL of the regional media server
        • serverRegion -- optional region identifier
        • regions -- optional list of available regions
    onError?: (error: Error) => void

    Callback invoked whenever a client-level error occurs.

    Use this to display error alerts, send to a crash reporting service, or trigger recovery logic in your application.

    Type Declaration

      • (error: Error): void

      • Parameters

        • error: Error

          The error that occurred

        Returns void

    storageAdapter?: StorageAdapter

    Optional storage adapter for persisting device preferences across sessions.

    When provided, selected audio/video device choices can be saved and restored automatically on subsequent connections.

    Settings

    Member Visibility

    On This Page

    Properties