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

    Interface HiyveStoreOptions

    Options for creating a HiyveStore instance

    interface HiyveStoreOptions {
        connectOptions?: { audioDeviceId?: string; videoDeviceId?: string };
        generateRoomToken?: () => Promise<string>;
        localVideoElementId?: string;
        onError?: (error: Error) => void;
        persistDeviceChanges?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    connectOptions? generateRoomToken? localVideoElementId? onError? persistDeviceChanges?

    Properties

    connectOptions?: { audioDeviceId?: string; videoDeviceId?: string }

    Initial device IDs to use when connecting

    generateRoomToken?: () => Promise<string>

    Async function that returns a Hiyve room token. Defaults to POSTing to /api/generate-room-token.

    localVideoElementId?: string

    ID of the HTML video element for local video preview (default: 'local-video')

    onError?: (error: Error) => void

    Callback invoked when a client error occurs

    persistDeviceChanges?: boolean

    Persist device changes to localStorage (default: false)

    Settings

    Member Visibility

    On This Page

    Properties