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

#include <ZoomSDKSettingService.h>

Inherits NSObject.

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

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

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

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

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

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

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

(ZoomSDKError)	- enableAutoJoinVoip:
	Enables 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:
	Enables the feature that attendee can speak by pressing the Spacebar when he is muted.

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

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

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

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

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

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

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

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

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

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

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

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

(ZoomSDKError)	- setEchoCancellationLevel:
	Sets echo cancellation level.

(ZoomSDKAudioEchoCancellationLevel)	- getEchoCancellationLevel
	Gets echo cancellation level.

(ZoomSDKError)	- enableEchoCancellation:
	Enables echo cancellation.

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

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

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

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

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

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

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

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

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

(ZoomSDKError)	- setRingSpkDevice:
	Select an audio device.

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

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

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

(BOOL)	- isHighFideMusicMode
	Determines 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

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

Parameters

disable YES if disabled, NO enabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableAlwaysUseSeparateRingSpk:

- (ZoomSDKError) enableAlwaysUseSeparateRingSpk: (BOOL) enable

Enables use separate audio device to play ringtone simultaneously.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableAutoAdjustMic:

- (ZoomSDKError) enableAutoAdjustMic: (BOOL) enable

Enables auto-adjust microphone.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableAutoJoinVoip:

- (ZoomSDKError) enableAutoJoinVoip: (BOOL) enable

Enables to join meeting with the audio of computer.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableEchoCancellation:

- (ZoomSDKError) enableEchoCancellation: (BOOL) enable

Enables echo cancellation.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableMuteMicJoinVoip:

- (ZoomSDKError) enableMuteMicJoinVoip: (BOOL) enable

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

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enablePushToTalk:

- (ZoomSDKError) enablePushToTalk: (BOOL) enable

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

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableShowOriginalSoundOptionInMeetingUI:

- (ZoomSDKError) enableShowOriginalSoundOptionInMeetingUI: (BOOL) enable

Enables show original sound option in meeting UI.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableStero:

- (ZoomSDKError) enableStero: (BOOL) enable

Sets to enable stereo in the meeting.

Parameters

enable YES to enable stereo, NO to disable.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ getAudioDeviceList:

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

Gets the list of audio device.

Parameters

mic	YES if microphone device, NO if speaker device.

Returns: If the function succeeds, it returns an array containing SDKDeviceInfo elements. Otherwise, this function fails and returns nil.

◆ getAudioDeviceVolume:

- (float) getAudioDeviceVolume: (BOOL) mic

Gets the volume of audio device.

Parameters

mic	YES if the volume of microphone device, NO if speaker device.

Returns: If the function succeeds, it returns an int value(0-100). Otherwise, this function fails and returns 0.

◆ getEchoCancellationLevel

- (ZoomSDKAudioEchoCancellationLevel) getEchoCancellationLevel

Gets echo cancellation level.

Returns: The level of echo cancellation.

◆ getRingSpkDeviceList

- (NSArray *_Nullable) getRingSpkDeviceList

Gets use separate audio device to play ringtone simultaneously devices.

Returns: If the function succeeds, it returns an array containing SDKDeviceInfo elements. Otherwise, this function fails and returns nil.

◆ getRingSpkVolume

- (float) getRingSpkVolume

Gets the volume of audio device.

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

◆ getSettingMicrophoneTestHelper

- (ZoomSDKSettingTestMicrophoneDeviceHelper *_Nullable) getSettingMicrophoneTestHelper

Gets the object of ZoomSDKSettingTestMicrophoneDeviceHelper.

Returns: If the function succeeds, it returns a ZoomSDKSettingTestMicrophoneDeviceHelper object. Otherwise, this function fails and returns nil.

◆ getSettingSpeakerTestHelper

- (ZoomSDKSettingTestSpeakerDeviceHelper *_Nullable) getSettingSpeakerTestHelper

Gets the object of ZoomSDKSettingTestSpeakerDeviceHelper.

Returns: If the function succeeds, it returns a ZoomSDKSettingTestSpeakerDeviceHelper object. Otherwise, this function fails and returns nil.

◆ getSuppressBackgroundNoiseLevel

- (ZoomSDKSuppressBackgroundNoiseLevel) getSuppressBackgroundNoiseLevel

Gets the level of suppressed background noise.

Returns: The level of suppressed background noise.

◆ isAlwaysUseSeparateRingSpkOn

- (BOOL) isAlwaysUseSeparateRingSpkOn

Determines if used separate audio device to play ringtone simultaneously.

Returns: YES if enabled. Otherwise, NO.

◆ isAutoAdjustMicOn

- (BOOL) isAutoAdjustMicOn

Determines if auto-adjust microphone is enabled or not.

Returns: YES if enabled. Otherwise, NO.

◆ isEchoCancellationOn

- (BOOL) isEchoCancellationOn

Determines if echo cancellation is enabled or not.

Returns: YES if enabled. Otherwise, NO.

◆ isEnableStereoOn

- (BOOL) isEnableStereoOn

Determines if stereophonic sound is enabled.

Returns: YES if enabled. Otherwise, NO.

◆ isHighFideMusicMode

- (BOOL) isHighFideMusicMode

Determines if use high fidelity music model.

Returns: YES if enabled. Otherwise, NO.

◆ isJoinAudioWhenJoinMeetingOn

- (BOOL) isJoinAudioWhenJoinMeetingOn

Determines if user joins meeting with audio on.

Returns: YES to enable the audio. Otherwise, NO.

◆ isMuteMicWhenJoinMeetingOn

- (BOOL) isMuteMicWhenJoinMeetingOn

Determines if user joins meeting with microphone muted.

Returns: YES if muted. Otherwise, NO.

◆ isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable

- (BOOL) isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable

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

Returns: YES if the dialog will not pop up. Otherwise, NO.

◆ isShowOriginalSoundOptionInMeetingUIOn

- (BOOL) isShowOriginalSoundOptionInMeetingUIOn

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

Returns: YES if enabled. Otherwise, NO.

◆ isSupportEchoCancellation

- (BOOL) isSupportEchoCancellation

Determines if the meeting supports echo cancellation.

Returns: YES if supported. Otherwise, NO.

◆ isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio

- (BOOL) isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio

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

Returns: YES if supported. Otherwise, NO.

◆ isSupportShowOriginalSoundOptionInMeetingUI

- (BOOL) isSupportShowOriginalSoundOptionInMeetingUI

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

Returns: YES if supported. Otherwise, NO.

◆ isSyncHeadsetButtonStatus

- (BOOL) isSyncHeadsetButtonStatus

Determines if sync buttons on headset option on or off.

Returns: YES if enabled. Otherwise, NO.

◆ isTemporarilyUnmuteOn

- (BOOL) isTemporarilyUnmuteOn

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

Returns: YES if enabled. Otherwise, NO.

◆ selectAudioDevice:DeviceID:DeviceName:

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

Select an audio device.

Parameters

mic	YES if microphone device, NO if speaker device.
deviceID	The device's ID.
deviceName	The device's name.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ selectSameAudioDeviceAsSystem:

- (ZoomSDKError) selectSameAudioDeviceAsSystem: (BOOL) mic

Select the same audio device as system.

Parameters

mic	YES if microphone device, NO if speaker device.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setAudioDeviceVolume:Volume:

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

Sets the volume of audio device.

Parameters

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

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setEchoCancellationLevel:

- (ZoomSDKError) setEchoCancellationLevel: (ZoomSDKAudioEchoCancellationLevel) level

Sets echo cancellation level.

Parameters

level The level to be set.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setHighFideMusicMode:

- (ZoomSDKError) setHighFideMusicMode: (BOOL) enable

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

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setRingSpkDevice:

- (ZoomSDKError) setRingSpkDevice: (NSString *) deviceId

Select an audio device.

Parameters

deviceId The ID of device.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setRingSpkVolume:

- (ZoomSDKError) setRingSpkVolume: (float) value

Sets the volume of audio device.

Parameters

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

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setSuppressBackgroundNoise:

- (ZoomSDKError) setSuppressBackgroundNoise: (ZoomSDKSuppressBackgroundNoiseLevel) level

Sets the level of to suppress background noise.

Parameters

level The level to be set.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setSyncHeadsetButtonStatus:

- (ZoomSDKError) setSyncHeadsetButtonStatus: (BOOL) enable

Sets enable sync buttons on headset.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

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