Class ZoomVideoSdkAudioHelper

Implements

ZoomVideoSdkAudioHelperType

Index

Constructors

Methods

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

Constructors

constructor

new ZoomVideoSdkAudioHelper(): ZoomVideoSdkAudioHelper
Returns ZoomVideoSdkAudioHelper

Methods

allowAudioUnmutedBySelf

allowAudioUnmutedBySelf(allowUnmute: boolean): Promise<any>
Allow attendees to unmute themselves.
Parameters
- allowUnmute: boolean
Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.allowAudioUnmutedBySelf
- Defined in native/ZoomVideoSdkAudioHelper.ts:133

canSwitchSpeaker

canSwitchSpeaker(): Promise<any>
Query if audio speaker enabled

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.canSwitchSpeaker
- Defined in native/ZoomVideoSdkAudioHelper.ts:121

cleanAudioSession

cleanAudioSession(): Promise<any>
Clean audio session including category and mode.

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.cleanAudioSession
- Defined in native/ZoomVideoSdkAudioHelper.ts:129

getSpeakerStatus

getSpeakerStatus(): Promise<any>
Get audio speaker status

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.getSpeakerStatus
- Defined in native/ZoomVideoSdkAudioHelper.ts:117

muteAllAudio

muteAllAudio(allowUnmute: boolean): Promise<any>
Mute all audio.
Parameters
- allowUnmute: boolean
Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.muteAllAudio
- Defined in native/ZoomVideoSdkAudioHelper.ts:137

muteAudio

muteAudio(userId: string): Promise<any>
Mute user audio by userId.
Parameters
- userId: string
Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.muteAudio
- Defined in native/ZoomVideoSdkAudioHelper.ts:97

resetAudioSession

resetAudioSession(): Promise<any>
Reset audio session including category and mode.

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.resetAudioSession
- Defined in native/ZoomVideoSdkAudioHelper.ts:125

setSDKAudioSessionEnv

setSDKAudioSessionEnv(): Promise<any>
Sets the AVAudioSession environment for Zoom Video SDK session (iOS only).

Returns Promise<any>
If the function succeeds, it returns true. Otherwise, false.
Implementation of ZoomVideoSdkAudioHelperType.setSDKAudioSessionEnv
- Defined in native/ZoomVideoSdkAudioHelper.ts:149

setSpeaker

setSpeaker(isOn: boolean): Promise<any>
Set audio speaker
Parameters
- isOn: boolean
Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.setSpeaker
- Defined in native/ZoomVideoSdkAudioHelper.ts:113

startAudio

startAudio(): Promise<any>
Start audio.

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.startAudio
- Defined in native/ZoomVideoSdkAudioHelper.ts:89

stopAudio

stopAudio(): Promise<any>
Stop audio.

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.stopAudio
- Defined in native/ZoomVideoSdkAudioHelper.ts:93

subscribe(): Promise<any>
Call the function to subscribe audio rawdata.

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.subscribe
- Defined in native/ZoomVideoSdkAudioHelper.ts:105

unmuteAllAudio

unmuteAllAudio(): Promise<any>
Unmute all audio.

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.unmuteAllAudio
- Defined in native/ZoomVideoSdkAudioHelper.ts:141

unmuteAudio

unmuteAudio(userId: string): Promise<any>
Unmute user audio by userId.
Parameters
- userId: string
Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.unmuteAudio
- Defined in native/ZoomVideoSdkAudioHelper.ts:101

unsubscribe

unsubscribe(): Promise<any>
Call the function to unsubscribe video or share raw data.

Returns Promise<any>
Implementation of ZoomVideoSdkAudioHelperType.unsubscribe
- Defined in native/ZoomVideoSdkAudioHelper.ts:109