ZoomToolSuiteAPI.Setting.Audio

Declaration

class Audio

Overview

Audio Setting Interface

ObjC Types and Enums Used by This Swift API

• ZoomToolSuiteBaseResult
• ZoomToolSuiteDeviceInfo
• ZoomToolSuiteIsShowOriginalSoundOptionResult
• ZoomToolSuiteIsUseOriginalSoundResult

Members

enableEchoCancellationFeature(bEnable:completion:)

static func enableEchoCancellationFeature(bEnable: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

enable echo cancellation

• Parameters:
• bEnable: enable
• completion: completion handler
• Returns: whether the API call is successful

enableHighFidelityMusicModeFeature(bEnable:completion:)

static func enableHighFidelityMusicModeFeature(bEnable: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

enable high fidelity music mode

• Parameters:
• bEnable: enable
• completion: completion handler
• Returns: whether the API call is successful

enableShowOriginalSoundOption(bEnable:completion:)

static func enableShowOriginalSoundOption(bEnable: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

enable / disable show original sound optionis

• Parameters:
• bEnable: enable / disable
• Returns: whether the API call is successful

enableStereoAudioFeature(bEnable:completion:)

static func enableStereoAudioFeature(bEnable: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

enable stereo audio

• Parameters:
• bEnable: enable
• completion: completion handler
• Returns: whether the API call is successful

enableUseOriginalSoundFeature(bEnable:completion:)

static func enableUseOriginalSoundFeature(bEnable: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

enable / disable original sound

• Parameters:
• bEnable: enable / disable
• completion: completion handler
• Returns: whether the API call is successful

getAudioDeviceList(bMic:)

static func getAudioDeviceList(bMic: Bool) -> [ZoomToolSuiteDeviceInfo]

get audio deviceList

• Parameter bMic: if true return all mic List , if false return all speaker list
• Returns: device List

isShowOriginalSoundOptionFeatureOn(completion:)

static func isShowOriginalSoundOptionFeatureOn(completion: @escaping (ZoomToolSuiteIsShowOriginalSoundOptionResult) -> Void) -> Bool

check whether show original sound optionis turn on or not

• Parameter completion: completion handler
• Returns: whether the API call is successful

isSupportUseOriginalSound()

static func isSupportUseOriginalSound() -> Bool

check whether is support use original sound or not

• Returns: whether the API call is successful

isUseOriginalSoundFeatureOn(completion:)

static func isUseOriginalSoundFeatureOn(completion: @escaping (ZoomToolSuiteIsUseOriginalSoundResult) -> Void) -> Bool

check whether use original sound is turn on or not

• Returns: whether the API call is successful

selectAudioDevice(bMic:deviceId:deviceName:completion:)

static func selectAudioDevice(bMic: Bool, deviceId: String, deviceName: String, completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

select audio device

• Parameters:
• bMic: bMic: if true device is mic , if false is speaker
• deviceId: deviceID
• deviceName: deviceName
• completion: completion handler
• Returns: whether the API call is successful

toggleOriginalSoundFeatureStatus(completion:)

static func toggleOriginalSoundFeatureStatus(completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

toggle user original sound

• Parameters:
• completionHandler: completion handler
• Returns: whether the API call is successful