Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKAudioSetting Class Reference

#import <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKSettingTestSpeakerDeviceHelper *) - getSettingSpeakerTestHelper
 Get the object of ZoomSDKSettingTestSpeakerDeviceHelper.
 
(ZoomSDKSettingTestMicrophoneDeviceHelper *) - getSettingMicrophoneTestHelper
 Get the object of ZoomSDKSettingTestMicrophoneDeviceHelper.
 
(NSArray *) - 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) - isPromptJoinAudioDialogWhenUse3rdPartyAudioDiable
 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) - isJoinAudoWhenJoinMeetingOn
 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 *) - 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< ZoomSDKSettingAudioDeviceDelegatedelegate
 

Detailed Description

Definition at line 279 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
disableYES 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
enableYES 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
enableYES 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
enableYES 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
enableYES 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
enableYES 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
enableYES 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
enableYES 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
enableYES means to enable stereo, No to disable.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ getAudioDeviceList:

- (NSArray *) getAudioDeviceList: (BOOL)  mic

Get the list of audio device.

Parameters
micYES 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
micYES 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 *) 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 *) getSettingMicrophoneTestHelper

Get the object of ZoomSDKSettingTestMicrophoneDeviceHelper.

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

◆ getSettingSpeakerTestHelper

- (ZoomSDKSettingTestSpeakerDeviceHelper *) 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.

◆ isJoinAudoWhenJoinMeetingOn

- (BOOL) isJoinAudoWhenJoinMeetingOn

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.

◆ isPromptJoinAudioDialogWhenUse3rdPartyAudioDiable

- (BOOL) isPromptJoinAudioDialogWhenUse3rdPartyAudioDiable

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
micYES means microphone device, No speaker device.
deviceIDThe ID of the device.
deviceNameThe 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
micYES 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
micYES means the volume of microphone device, No speaker device.
volumeThe 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
levelThe 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
enableYES 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
deviceIdThe 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
valueThe 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
levelThe 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
enableYES 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 283 of file ZoomSDKSettingService.h.

◆ _micTestHelper

- (ZoomSDKSettingTestMicrophoneDeviceHelper*) _micTestHelper
protected

Definition at line 282 of file ZoomSDKSettingService.h.

◆ _speakerTestHelper

- (ZoomSDKSettingTestSpeakerDeviceHelper*) _speakerTestHelper
protected

Definition at line 281 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingAudioDeviceDelegate>) delegate
readwritenonatomicassign

Definition at line 285 of file ZoomSDKSettingService.h.