ZoomVideoSdkAudioHelper class - zoom_videosdk_audio_helper library

Constructors

ZoomVideoSdkAudioHelper()

Properties

hashCode → int: The hash code for this object.
no setterinherited
methodChannel → MethodChannel: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

allowAudioUnmutedBySelf(bool allowUnmute) → Future<String>: Allow the others unmute by themself or not. For host or manager. allowUnmute = true means allow the user unmute themself, otherwise false.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
canSwitchSpeaker() → Future<bool>: Query is audio speaker enable.
Return true: enable false: disable (some pad not support telephony,or some device not support)
cleanAudioSession() → Future<void>: clean audio session, it will release audio session
getAudioDeviceList() → Future<List<ZoomVideoSdkAudioDevice>?>: Get the audio device list.
The function is only available for Android platform.
Return List of the audio device if the function succeeds. Otherwise, NULL.
getAvailableAudioInputsDevice() → Future<List<ZoomVideoSdkAudioDevice>?>: Get the available audio input device.
The function is only available for iOS platform.
Return List of the audio input device if the function succeeds.
getAvailableAudioOutputRoute() → Future<List<ZoomVideoSdkAudioDevice>?>: Get the available audio output route.
The function is only available for iOS platform.
Return List of the audio output route if the function succeeds.
getCurrentAudioInputDevice() → Future<ZoomVideoSdkAudioDevice>: Get the current audio input device.
The function is only available for iOS platform.
Return the current audio input device if the function succeeds.
getCurrentAudioOutputRoute() → Future<ZoomVideoSdkAudioDevice>: Get the current audio output route.
The function is only available for iOS platform.
Return the current audio output route if the function succeeds.
getSpeakerStatus() → Future<bool>: Get audio speaker status
Return true: speaker false: headset or earSpeaker
getUsingAudioDevice() → Future<ZoomVideoSdkAudioDevice>: Get the current using audio device.
The function is only available for Android platform.
Return the current using audio device if the function succeeds. Otherwise, NULL
muteAllAudio(bool allowUnmute) → Future<String>: Mute all user's audio except my self. allowUnmute = true means allow the user unmute themself, otherwise false.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
muteAudio(String userId) → Future<String>: mute user's voip audio by userId
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
resetAudioSession() → Future<bool>: reset audio session, it will stop and start audio session
Return true indicates success, otherwise false.
setAudioInputDevice(String deviceName) → Future<bool>: Set the specified audio input device by deviceName.
deviceName The device name of the specified audio input device must be in the audio input device list.
This function is only available for iOS platform.
Return true indicates success, otherwise false.
setAudioOutputRoute(String deviceName) → Future<bool>: Set the specified audio output route by deviceName.
deviceName The device name of the specified audio output route must be in the audio output route list.
This function is only available for iOS platform.
Return true indicates success, otherwise false.
setSpeaker(bool isOn) → Future<void>: Set audio speaker
isOn = true if is speaker
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
startAudio() → Future<String>: Start audio with voip
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
stopAudio() → Future<String>: Stop voip
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
subscribe() → Future<String>: subscribe audio raw data.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
switchToAudioSourceType(String deviceName) → Future<String>: Switch to the specified audio device by deviceName.
deviceName The device name of the specified audio device must be in the audio device list.
This function is only available for Android platform.
Return true indicates success, otherwise false.
toString() → String: A string representation of this object.
inherited
unmuteAllAudio() → Future<String>: Ask unmute all user's audio. Only host or manager can ask unmute all user's audio. This functinon will trigger the callback onHostAskUnmute().
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
unMuteAudio(String userId) → Future<String>: unmute user's voip audio by userId
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
unSubscribe() → Future<String>: unsubscribe audio raw data
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.

Operators

operator ==(Object other) → bool: The equality operator.
inherited