Zoom SDK
Instance Methods | Protected Attributes | Properties | List of all members
ZoomSDKAudioSetting Class Reference
Inheritance diagram for ZoomSDKAudioSetting:

Instance Methods

(ZoomSDKSettingTestSpeakerDeviceHelper *) - getSettingSpeakerTestHelper
 Get the object of ZoomSDKSettingTestSpeakerDeviceHelper. More...
 
(ZoomSDKSettingTestMicrophoneDeviceHelper *) - getSettingMicrophoneTestHelper
 Get the object of ZoomSDKSettingTestMicrophoneDeviceHelper. More...
 
(NSArray *) - getAudioDeviceList:
 Get the list of audio device. More...
 
(int) - getAudioDeviceVolume:
 Get the volume of audio device. More...
 
(ZoomSDKError) - setAudioDeviceVolume:Volume:
 Set the volume of audio device. More...
 
(ZoomSDKError) - selectAudioDevice:DeviceID:DeviceName:
 Select an audio device. More...
 
(ZoomSDKError) - enableStero:
 Set to enable stereo in the meeting. More...
 
(ZoomSDKError) - enableAutoJoinVoip:
 Enable to join meeting with the audio of computer. More...
 
(ZoomSDKError) - enableMuteMicJoinVoip:
 Mute user's microphone when he joins the meeting with the audio of computer. More...
 
(ZoomSDKError) - enablePushToTalk:
 Enable the feature that attendee can speak by pressing the Spacebar when he is muted. More...
 
(ZoomSDKError) - disablePromptJoinAudioDialogWhenUse3rdPartyAudio:
 Set whether to disable the prompt dialog of joining meeting with third party audio. More...
 
(BOOL) - isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio
 Determine if the meeting supports to pop up the dialog when user joins meeting with third party audio. More...
 
(BOOL) - isPromptJoinAudioDialogWhenUse3rdPartyAudioDiable
 Determine if the dialog pops up when user joins meeting with third party audio. More...
 
(ZoomSDKError) - enableAutoAdjustMic:
 Enable auto-adjust microphone. More...
 
(BOOL) - isAutoAdjustMicOn
 Determine if auto-adjust microphone is enabled or not. More...
 
(BOOL) - isJoinAudoWhenJoinMeetingOn
 Determine if user joins meeting with audio on. More...
 
(BOOL) - isMuteMicWhenJoinMeetingOn
 Determine if user joins meeting with microphone muted. More...
 
(BOOL) - isSupportStereo
 Determine if the meeting supports stereophonic sound. More...
 
(BOOL) - isEnableStereoOn
 Determine if stereophonic sound is enabled. More...
 
(BOOL) - isTemporarilyUnmuteOn
 Set whether to enable the feature that attendee can speak by pressing the Spacebar when he is muted. More...
 
(ZoomSDKError) - enableShowOriginalSoundOptionInMeetingUI:
 Enable show original sound option in meeting UI. More...
 
(BOOL) - isShowOriginalSoundOptionInMeetingUIOn
 Determine if show original sound option in meeting UI is enabled or not. More...
 
(BOOL) - isSupportShowOriginalSoundOptionInMeetingUI
 Determine if the meeting supports show original sound option in meeting UI. More...
 
(ZoomSDKError) - enableEchoCancellation:
 Enable echo cancellation. More...
 
(BOOL) - isEchoCancellationOn
 Determine if echo cancellation is enabled or not. More...
 
(BOOL) - isSupportEchoCancellation
 Determine if the meeting supports echo cancellation. More...
 
(ZoomSDKSuppressBackgroundNoiseLevel) - getSuppressBackgroundNoiseLevel
 Get the level of suppressed background noise. More...
 
(ZoomSDKError) - setSuppressBackgroundNoise:
 Set the level of to suppress background noise. More...
 

Protected Attributes

ZoomSDKSettingTestSpeakerDeviceHelper_speakerTestHelper
 
ZoomSDKSettingTestMicrophoneDeviceHelper_micTestHelper
 
id< ZoomSDKSettingAudioDeviceDelegate_delegate
 

Properties

id< ZoomSDKSettingAudioDeviceDelegatedelegate
 

Method Documentation

◆ disablePromptJoinAudioDialogWhenUse3rdPartyAudio:

- (ZoomSDKError) disablePromptJoinAudioDialogWhenUse3rdPartyAudio: (BOOL)  disable

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

Parameters
enableYES means disabled, NO enabled.
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 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:

- (int) 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.

◆ 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.

◆ isAutoAdjustMicOn

- (BOOL) isAutoAdjustMicOn

Determine if auto-adjust microphone is enabled or not.

Returns
YES means enabled, otherwise not.

◆ 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.

◆ 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.

◆ isSupportStereo

- (BOOL) isSupportStereo

Determine if the meeting supports stereophonic sound.

Returns
YES means supported, 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.

◆ setAudioDeviceVolume:Volume:

- (ZoomSDKError) setAudioDeviceVolume: (BOOL)  mic
Volume: (int)  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.

◆ 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.

The documentation for this class was generated from the following file: