Provides APIs to manage audio devices, audio volumes, and audio-related meeting features. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKSettingTestSpeakerDeviceHelper *_Nullable)	- getSettingSpeakerTestHelper
	Get the object of ZoomSDKSettingTestSpeakerDeviceHelper.

(ZoomSDKSettingTestMicrophoneDeviceHelper *_Nullable)	- getSettingMicrophoneTestHelper
	Get the object of ZoomSDKSettingTestMicrophoneDeviceHelper.

(NSArray *_Nullable)	- getAudioDeviceList:
	Get the list of audio device.

(float)	- getAudioDeviceVolume:
	Get the volume of audio device.

(ZoomSDKError)	- setAudioDeviceVolume:Volume:
	Set the volume of audio device.

(ZoomSDKError)	- selectAudioDevice:DeviceID:DeviceName:
	Select an audio device.

(ZoomSDKError)	- enableStero:
	Set to enable stereo in the meeting.

(ZoomSDKError)	- enableAutoJoinVoip:
	Enable to join meeting with the audio of computer.

(ZoomSDKError)	- enableMuteMicJoinVoip:
	Mute user's microphone when he joins the meeting with the audio of computer.

(ZoomSDKError)	- enablePushToTalk:
	Enable the feature that attendee can speak by pressing the Spacebar when he is muted.

(ZoomSDKError)	- disablePromptJoinAudioDialogWhenUse3rdPartyAudio:
	Set whether to disable the prompt dialog of joining meeting with third party audio.

(BOOL)	- isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio
	Determine if the meeting supports to pop up the dialog when user joins meeting with third party audio.

(BOOL)	- isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable
	Determine if the dialog pops up when user joins meeting with third party audio.

(ZoomSDKError)	- enableAutoAdjustMic:
	Enable auto-adjust microphone.

(BOOL)	- isAutoAdjustMicOn
	Determine if auto-adjust microphone is enabled or not.

(BOOL)	- isJoinAudioWhenJoinMeetingOn
	Determine if user joins meeting with audio on.

(BOOL)	- isMuteMicWhenJoinMeetingOn
	Determine if user joins meeting with microphone muted.

(BOOL)	- isEnableStereoOn
	Determine if stereophonic sound is enabled.

(BOOL)	- isTemporarilyUnmuteOn
	Set whether to enable the feature that attendee can speak by pressing the Spacebar when he is muted.

(ZoomSDKError)	- enableShowOriginalSoundOptionInMeetingUI:
	Enable show original sound option in meeting UI.

(BOOL)	- isShowOriginalSoundOptionInMeetingUIOn
	Determine if show original sound option in meeting UI is enabled or not.

(BOOL)	- isSupportShowOriginalSoundOptionInMeetingUI
	Determine if the meeting supports show original sound option in meeting UI.

(ZoomSDKError)	- setEchoCancellationLevel:
	Set echo cancellation level.

(ZoomSDKAudioEchoCancellationLevel)	- getEchoCancellationLevel
	Get echo cancellation level.

(ZoomSDKError)	- enableEchoCancellation:
	Enable echo cancellation.

(BOOL)	- isEchoCancellationOn
	Determine if echo cancellation is enabled or not.

(BOOL)	- isSupportEchoCancellation
	Determine if the meeting supports echo cancellation.

(ZoomSDKSuppressBackgroundNoiseLevel)	- getSuppressBackgroundNoiseLevel
	Get the level of suppressed background noise.

(ZoomSDKError)	- setSuppressBackgroundNoise:
	Set the level of to suppress background noise.

(BOOL)	- isAlwaysUseSeparateRingSpkOn
	Determine if used separate audio device to play ringtone simultaneously.

(ZoomSDKError)	- enableAlwaysUseSeparateRingSpk:
	Enable use separate audio device to play ringtone simultaneously.

(NSArray *_Nullable)	- getRingSpkDeviceList
	Get use separate audio device to play ringtone simultaneously devices.

(float)	- getRingSpkVolume
	Get the volume of audio device.

(ZoomSDKError)	- setRingSpkVolume:
	Set the volume of audio device.

(ZoomSDKError)	- setRingSpkDevice:
	Select an audio device.

(ZoomSDKError)	- setSyncHeadsetButtonStatus:
	Set enable sync buttons on headset.

(BOOL)	- isSyncHeadsetButtonStatus
	Determine if sync buttons on headset option on or off.

(ZoomSDKError)	- setHighFideMusicMode:
	Set the "Enable Original Sound" option is high fidelity music model.

(BOOL)	- isHighFideMusicMode
	Determine if use high fidelity music model.

(ZoomSDKError)	- selectSameAudioDeviceAsSystem:
	Select the same audio device as system.

Protected Attributes
ZoomSDKSettingTestSpeakerDeviceHelper *	_speakerTestHelper

ZoomSDKSettingTestMicrophoneDeviceHelper *	_micTestHelper

id< ZoomSDKSettingAudioDeviceDelegate >	_delegate

Properties
id< ZoomSDKSettingAudioDeviceDelegate >	delegate
	Delegate to receive audio device status changes.

Detailed Description

Provides APIs to manage audio devices, audio volumes, and audio-related meeting features.

Definition at line 464 of file ZoomSDKSettingService.h.

Method Documentation

◆ disablePromptJoinAudioDialogWhenUse3rdPartyAudio:

- (ZoomSDKError) disablePromptJoinAudioDialogWhenUse3rdPartyAudio: (BOOL) disable

Set whether to disable the prompt dialog of joining meeting with third party audio.

Parameters

disable YES means disabled, NO enabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableAlwaysUseSeparateRingSpk:

- (ZoomSDKError) enableAlwaysUseSeparateRingSpk: (BOOL) enable

Enable use separate audio device to play ringtone simultaneously.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableAutoAdjustMic:

- (ZoomSDKError) enableAutoAdjustMic: (BOOL) enable

Enable auto-adjust microphone.

Parameters

enable YES means enabled, NO means disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableAutoJoinVoip:

- (ZoomSDKError) enableAutoJoinVoip: (BOOL) enable

Enable to join meeting with the audio of computer.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableEchoCancellation:

- (ZoomSDKError) enableEchoCancellation: (BOOL) enable

Enable echo cancellation.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableMuteMicJoinVoip:

- (ZoomSDKError) enableMuteMicJoinVoip: (BOOL) enable

Mute user's microphone when he joins the meeting with the audio of computer.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enablePushToTalk:

- (ZoomSDKError) enablePushToTalk: (BOOL) enable

Enable the feature that attendee can speak by pressing the Spacebar when he is muted.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableShowOriginalSoundOptionInMeetingUI:

- (ZoomSDKError) enableShowOriginalSoundOptionInMeetingUI: (BOOL) enable

Enable show original sound option in meeting UI.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableStero:

- (ZoomSDKError) enableStero: (BOOL) enable

Set to enable stereo in the meeting.

Parameters

enable YES means to enable stereo, No to disable.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ getAudioDeviceList:

- (NSArray *_Nullable) getAudioDeviceList: (BOOL) mic

Get the list of audio device.

Parameters

mic	YES means microphone device, No speaker device.

Returns: If the function succeeds, it will return an array containing SDKDeviceInfo elements, otherwise returns nil.

◆ getAudioDeviceVolume:

- (float) getAudioDeviceVolume: (BOOL) mic

Get the volume of audio device.

Parameters

mic	YES means the volume of microphone device, No speaker device.

Returns: If the function succeeds, it will return an int value(0-100), otherwise returns nil.

◆ getEchoCancellationLevel

- (ZoomSDKAudioEchoCancellationLevel) getEchoCancellationLevel

Get echo cancellation level.

Returns: The level of echo cancellation.

◆ getRingSpkDeviceList

- (NSArray *_Nullable) getRingSpkDeviceList

Get use separate audio device to play ringtone simultaneously devices.

Returns: If the function succeeds, it will return an array containing SDKDeviceInfo elements, otherwise returns nil.

◆ getRingSpkVolume

- (float) getRingSpkVolume

Get the volume of audio device.

Returns: If the function succeeds, it will return an float value(0.0-255.0), otherwise returns 0.0.

◆ getSettingMicrophoneTestHelper

- (ZoomSDKSettingTestMicrophoneDeviceHelper *_Nullable) getSettingMicrophoneTestHelper

Get the object of ZoomSDKSettingTestMicrophoneDeviceHelper.

Returns: If the function succeeds, it will return a ZoomSDKSettingTestMicrophoneDeviceHelper object. Otherwise returns nil.

◆ getSettingSpeakerTestHelper

- (ZoomSDKSettingTestSpeakerDeviceHelper *_Nullable) getSettingSpeakerTestHelper

Get the object of ZoomSDKSettingTestSpeakerDeviceHelper.

Returns: If the function succeeds, it will return a ZoomSDKSettingTestSpeakerDeviceHelper object. Otherwise returns nil.

◆ getSuppressBackgroundNoiseLevel

- (ZoomSDKSuppressBackgroundNoiseLevel) getSuppressBackgroundNoiseLevel

Get the level of suppressed background noise.

Returns: The level of suppressed background noise.

◆ isAlwaysUseSeparateRingSpkOn

- (BOOL) isAlwaysUseSeparateRingSpkOn

Determine if used separate audio device to play ringtone simultaneously.

Returns: YES means enabled, otherwise not.

◆ isAutoAdjustMicOn

- (BOOL) isAutoAdjustMicOn

Determine if auto-adjust microphone is enabled or not.

Returns: YES means enabled, otherwise it is not enabled.

◆ isEchoCancellationOn

- (BOOL) isEchoCancellationOn

Determine if echo cancellation is enabled or not.

Returns: YES means enabled, otherwise not.

◆ isEnableStereoOn

- (BOOL) isEnableStereoOn

Determine if stereophonic sound is enabled.

Returns: YES means enabled, otherwise not.

◆ isHighFideMusicMode

- (BOOL) isHighFideMusicMode

Determine if use high fidelity music model.

Returns: YES means enabled, otherwise not.

◆ isJoinAudioWhenJoinMeetingOn

- (BOOL) isJoinAudioWhenJoinMeetingOn

Determine if user joins meeting with audio on.

Returns: YES means to enable the audio, otherwise not.

◆ isMuteMicWhenJoinMeetingOn

- (BOOL) isMuteMicWhenJoinMeetingOn

Determine if user joins meeting with microphone muted.

Returns: YES means muted, otherwise not.

◆ isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable

- (BOOL) isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable

Determine if the dialog pops up when user joins meeting with third party audio.

Returns: YES means that the dialog will not pop up, otherwise not.

◆ isShowOriginalSoundOptionInMeetingUIOn

- (BOOL) isShowOriginalSoundOptionInMeetingUIOn

Determine if show original sound option in meeting UI is enabled or not.

Returns: YES means enabled, otherwise not.

◆ isSupportEchoCancellation

- (BOOL) isSupportEchoCancellation

Determine if the meeting supports echo cancellation.

Returns: YES means supported, otherwise not.

◆ isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio

- (BOOL) isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio

Determine if the meeting supports to pop up the dialog when user joins meeting with third party audio.

Returns: YES means supported, otherwise not.

◆ isSupportShowOriginalSoundOptionInMeetingUI

- (BOOL) isSupportShowOriginalSoundOptionInMeetingUI

Determine if the meeting supports show original sound option in meeting UI.

Returns: YES means supported, otherwise not.

◆ isSyncHeadsetButtonStatus

- (BOOL) isSyncHeadsetButtonStatus

Determine if sync buttons on headset option on or off.

Returns: YES means enabled, otherwise not.

◆ isTemporarilyUnmuteOn

- (BOOL) isTemporarilyUnmuteOn

Set whether to enable the feature that attendee can speak by pressing the Spacebar when he is muted.

Returns: YES means enabled, otherwise not.

◆ selectAudioDevice:DeviceID:DeviceName:

- (ZoomSDKError) selectAudioDevice:	(BOOL)	mic
DeviceID:	(NSString *)	deviceID
DeviceName:	(NSString *)	deviceName

Select an audio device.

Parameters

mic	YES means microphone device, No speaker device.
deviceID	The ID of the device.
deviceName	The name of the device.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ selectSameAudioDeviceAsSystem:

- (ZoomSDKError) selectSameAudioDeviceAsSystem: (BOOL) mic

Select the same audio device as system.

Parameters

mic	YES means microphone device, No speaker device.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setAudioDeviceVolume:Volume:

- (ZoomSDKError) setAudioDeviceVolume:		(BOOL)	mic
Volume:		(float)	volume

Set the volume of audio device.

Parameters

mic	YES means the volume of microphone device, No speaker device.
volume	The volume of device, varies from 0 to 100.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ setEchoCancellationLevel:

- (ZoomSDKError) setEchoCancellationLevel: (ZoomSDKAudioEchoCancellationLevel) level

Set echo cancellation level.

Parameters

level The level to be set.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setHighFideMusicMode:

- (ZoomSDKError) setHighFideMusicMode: (BOOL) enable

Set the "Enable Original Sound" option is high fidelity music model.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setRingSpkDevice:

- (ZoomSDKError) setRingSpkDevice: (NSString *) deviceId

Select an audio device.

Parameters

deviceId The id of device.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setRingSpkVolume:

- (ZoomSDKError) setRingSpkVolume: (float) value

Set the volume of audio device.

Parameters

value The value of device, varies from 0.0 to 255.0.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setSuppressBackgroundNoise:

- (ZoomSDKError) setSuppressBackgroundNoise: (ZoomSDKSuppressBackgroundNoiseLevel) level

Set the level of to suppress background noise.

Parameters

level The level to be set.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setSyncHeadsetButtonStatus:

- (ZoomSDKError) setSyncHeadsetButtonStatus: (BOOL) enable

Set enable sync buttons on headset.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

Field Documentation

◆ _delegate

- (id<ZoomSDKSettingAudioDeviceDelegate>) _delegate

protected

Definition at line 468 of file ZoomSDKSettingService.h.

◆ _micTestHelper

- (ZoomSDKSettingTestMicrophoneDeviceHelper*) _micTestHelper

protected

Definition at line 467 of file ZoomSDKSettingService.h.

◆ _speakerTestHelper

- (ZoomSDKSettingTestSpeakerDeviceHelper*) _speakerTestHelper

protected

Definition at line 466 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingAudioDeviceDelegate>) delegate

readwritenonatomicassign

Delegate to receive audio device status changes.

Definition at line 473 of file ZoomSDKSettingService.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ disablePromptJoinAudioDialogWhenUse3rdPartyAudio:

◆ enableAlwaysUseSeparateRingSpk:

◆ enableAutoAdjustMic:

◆ enableAutoJoinVoip:

◆ enableEchoCancellation:

◆ enableMuteMicJoinVoip:

◆ enablePushToTalk:

◆ enableShowOriginalSoundOptionInMeetingUI:

◆ enableStero:

◆ getAudioDeviceList:

◆ getAudioDeviceVolume:

◆ getEchoCancellationLevel

◆ getRingSpkDeviceList

◆ getRingSpkVolume

◆ getSettingMicrophoneTestHelper

◆ getSettingSpeakerTestHelper

◆ getSuppressBackgroundNoiseLevel

◆ isAlwaysUseSeparateRingSpkOn

◆ isAutoAdjustMicOn

◆ isEchoCancellationOn

◆ isEnableStereoOn

◆ isHighFideMusicMode

◆ isJoinAudioWhenJoinMeetingOn

◆ isMuteMicWhenJoinMeetingOn

◆ isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable

◆ isShowOriginalSoundOptionInMeetingUIOn

◆ isSupportEchoCancellation

◆ isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio

◆ isSupportShowOriginalSoundOptionInMeetingUI

◆ isSyncHeadsetButtonStatus

◆ isTemporarilyUnmuteOn

◆ selectAudioDevice:DeviceID:DeviceName:

◆ selectSameAudioDeviceAsSystem:

◆ setAudioDeviceVolume:Volume:

◆ setEchoCancellationLevel:

◆ setHighFideMusicMode:

◆ setRingSpkDevice:

◆ setRingSpkVolume:

◆ setSuppressBackgroundNoise:

◆ setSyncHeadsetButtonStatus:

Field Documentation

◆ _delegate

◆ _micTestHelper

◆ _speakerTestHelper

Property Documentation

◆ delegate