Function useUserMediaDevices

  • useUserMediaDevices hook

    Returns

    userMediaDevices, selectedAudioIn, selectedAudioInId, setSelectedAudioIn, selectedAudioOut, selectedAudioInId, setSelectedAudioOut, selectedVideoIn, selectedVideoInId, setSelectedVideoIn

    Parameters

    • session: undefined | Session

      a valid ApiRTC Session

    • Optional storageKeyPrefix: string

      do not set or set to undefined to NOT use local storage to get nor store devices ids.

    Returns {
        selectedAudioIn: undefined | MediaDevice;
        selectedAudioInId: undefined | string;
        selectedAudioOut: undefined | MediaDevice;
        selectedAudioOutId: undefined | string;
        selectedVideoIn: undefined | MediaDevice;
        selectedVideoInId: undefined | string;
        setSelectedAudioIn: Dispatch<SetStateAction<undefined | MediaDevice>>;
        setSelectedAudioOut: Dispatch<SetStateAction<undefined | MediaDevice>>;
        setSelectedVideoIn: Dispatch<SetStateAction<undefined | MediaDevice>>;
        userMediaDevices: MediaDeviceList;
    }

    • selectedAudioIn: undefined | MediaDevice
    • selectedAudioInId: undefined | string
    • selectedAudioOut: undefined | MediaDevice
    • selectedAudioOutId: undefined | string
    • selectedVideoIn: undefined | MediaDevice
    • selectedVideoInId: undefined | string
    • setSelectedAudioIn: Dispatch<SetStateAction<undefined | MediaDevice>>
    • setSelectedAudioOut: Dispatch<SetStateAction<undefined | MediaDevice>>
    • setSelectedVideoIn: Dispatch<SetStateAction<undefined | MediaDevice>>
    • userMediaDevices: MediaDeviceList

Settings

Member Visibility

Theme

Generated using TypeDoc