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

    Interface UseDeviceManagementOptions

    Options for the useDeviceManagement hook

    interface UseDeviceManagementOptions {
        client: DeviceClient | null;
        currentAudioOutputDeviceId?: string | null;
        disabled?: boolean;
        labels: Pick<
            ControlBarLabels,
            "cameraFallback"
            | "microphoneFallback"
            | "speakerFallback",
        >;
        onAudioDeviceChange?: (deviceId: string) => void;
        onAudioOutputDeviceChange?: (deviceId: string) => void;
        onError?: (error: Error, operation: string) => void;
        onVideoDeviceChange?: (deviceId: string) => void;
        setAudioInputDevice: (deviceId: string) => void;
        setAudioOutputDevice: (deviceId: string) => void;
        setVideoDevice: (deviceId: string) => void;
    }
    Index

    Properties

    client currentAudioOutputDeviceId? disabled? labels onAudioDeviceChange? onAudioOutputDeviceChange? onError? onVideoDeviceChange? setAudioInputDevice setAudioOutputDevice setVideoDevice

    Properties

    client: DeviceClient | null

    The client instance for device operations

    currentAudioOutputDeviceId?: string | null

    The selected speaker device id from app state (e.g. useLocalMedia). Audio output isn't applied to the WebRTC client at join — it lives in app state and is applied via setSinkId — so the client can't report it. Pass it here so the menu reflects the active speaker rather than the first device.

    disabled?: boolean

    Whether controls are disabled

    labels: Pick<
        ControlBarLabels,
        "cameraFallback"
        | "microphoneFallback"
        | "speakerFallback",
    >

    Labels for device fallback names

    onAudioDeviceChange?: (deviceId: string) => void
    onAudioOutputDeviceChange?: (deviceId: string) => void
    onError?: (error: Error, operation: string) => void
    onVideoDeviceChange?: (deviceId: string) => void

    Callbacks

    setAudioInputDevice: (deviceId: string) => void
    setAudioOutputDevice: (deviceId: string) => void
    setVideoDevice: (deviceId: string) => void

    Context hooks for device persistence

    Settings

    Member Visibility

    On This Page

    Properties