@zoom/react-native-videosdk
    Preparing search index...

    Type Alias ZoomVideoSdkAudioHelperType

    A class to operate the audio action.

    type ZoomVideoSdkAudioHelperType = {
        allowAudioUnmutedBySelf: (allowUnmute: boolean) => void;
        canSwitchSpeaker: () => Promise<boolean>;
        cleanAudioSession: () => void;
        getSpeakerStatus: () => Promise<boolean>;
        muteAllAudio: (allowUnmute: boolean) => Promise<Errors>;
        muteAudio: (userId: string) => Promise<Errors>;
        resetAudioSession: () => Promise<boolean>;
        setSDKAudioSessionEnv: () => Promise<boolean>;
        setSpeaker: (isOn: boolean) => Promise<Errors>;
        startAudio: () => Promise<Errors>;
        stopAudio: () => Promise<Errors>;
        subscribe: () => Promise<Errors>;
        unmuteAllAudio: () => Promise<Errors>;
        unmuteAudio: (userId: string) => Promise<Errors>;
        unsubscribe: () => Promise<Errors>;
    }

    Implemented by

    Index

    Properties

    allowAudioUnmutedBySelf canSwitchSpeaker cleanAudioSession getSpeakerStatus muteAllAudio muteAudio resetAudioSession setSDKAudioSessionEnv setSpeaker startAudio stopAudio subscribe unmuteAllAudio unmuteAudio unsubscribe

    Properties

    allowAudioUnmutedBySelf: (allowUnmute: boolean) => void

    Allow attendees to unmute themselves.

    canSwitchSpeaker: () => Promise<boolean>

    Query if audio speaker enabled

    cleanAudioSession: () => void

    Clean audio session including category and mode.

    getSpeakerStatus: () => Promise<boolean>

    Get audio speaker status

    muteAllAudio: (allowUnmute: boolean) => Promise<Errors>

    Mute all audio.

    muteAudio: (userId: string) => Promise<Errors>

    Mute user audio by userId.

    resetAudioSession: () => Promise<boolean>

    Reset audio session including category and mode.

    setSDKAudioSessionEnv: () => Promise<boolean>

    Sets the AVAudioSession environment for the current session. Only iOS is supported.

    setSpeaker: (isOn: boolean) => Promise<Errors>

    Set audio speaker

    startAudio: () => Promise<Errors>

    Start audio.

    stopAudio: () => Promise<Errors>

    Stop audio.

    subscribe: () => Promise<Errors>

    Call the function to subscribe audio rawdata.

    unmuteAllAudio: () => Promise<Errors>

    Unmute all audio.

    unmuteAudio: (userId: string) => Promise<Errors>

    Unmute user audio by userId.

    unsubscribe: () => Promise<Errors>

    Call the function to unsubscribe video or share raw data.

    Settings

    Member Visibility

    On This Page

    Properties