Type Alias ZoomVideoSdkAudioHelperType

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>;
    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>;
}

A class to operate the audio action.

Type declaration

  • 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.

  • 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