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

    Interface HiyveStoreOptions

    Options for creating a HiyveStore instance

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

    Hierarchy (View Summary)

    Index

    Properties

    connectOptions? enableAudioMerge? generateRoomToken? localVideoElementId? onError? persistDeviceChanges?

    Properties

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

    Initial device IDs to use when connecting

    enableAudioMerge?: boolean

    Enable the rtc-client's audio-merge facility on every transport connection. When true, the client builds an AudioMerger on top of the local mic so callers can mix additional MediaStreams into the outbound audio track via client.mergeAudioInput({ stream }) / client.unmergeAudioInput({ stream }) — used by apps that need to broadcast secondary audio (a metronome click, a backing track, a clip's playback) to every other participant in the room without routing through a separate WebRTC track.

    Off by default to keep the resource footprint of vanilla audio-conferencing rooms unchanged (no extra AudioContext / merger graph). Apps that need it should set this to true once on the provider — the option flows through every internal connectTransports call (initial create/join + admit-into-room after a waiting-room hold + reconnect paths).

    false
    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