ZMVideoSDKAudioSettingHelper Class Reference

Interface for managing audio settings in Zoom Video SDK. More...

#include <ZMVideoSDKAudioSettingHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- getSuppressBackgroundNoiseLevel:
	Get the suppress background noise level.
(ZMVideoSDKErrors)	- setSuppressBackgroundNoiseLevel:
	Set the suppress background noise level.
(ZMVideoSDKErrors)	- enableMicOriginalInput:
	Call this method to enable or disable the original input of mic.
(ZMVideoSDKErrors)	- isMicOriginalInputEnable:
	Determine whether the original input of the microphone is enabled.
(ZMVideoSDKErrors)	- enableHighFidelityMusicMode:
	Set whether to enable the function of high fidelity music mode or not.
(ZMVideoSDKErrors)	- isHighFidelityMusicModeEnable:
	Check whether the high fidelity music mode is enabled or not.
(ZMVideoSDKErrors)	- enableEchoCancellation:
	Set whether to disable the function of echo cancellation or not.
(ZMVideoSDKErrors)	- isEchoCancellationEnable:
	Check whether the echo cancellation is enabled or not.
(ZMVideoSDKErrors)	- enableStereoAudio:
	Set whether to enable stereo audio.
(ZMVideoSDKErrors)	- isStereoAudioEnable:
	Check whether the stereo audio is enabled or not.
(ZMVideoSDKErrors)	- getEchoCancellationLevel:
	Get the echo cancellation level.
(ZMVideoSDKErrors)	- setEchoCancellationLevel:
	Set the echo cancellation level.
(ZMVideoSDKErrors)	- enableAutoAdjustMicVolume:
	Call this method to enable or disable the auto adjust input of microphone volume.
(ZMVideoSDKErrors)	- isAutoAdjustMicVolumeEnabled:
	Determine whether the original input of the microphone volume is enabled.

Detailed Description

Interface for managing audio settings in Zoom Video SDK.

Definition at line 63 of file ZMVideoSDKAudioSettingHelper.h.

Method Documentation

enableAutoAdjustMicVolume:

- (ZMVideoSDKErrors) enableAutoAdjustMicVolume:

(BOOL)

bEnable

Call this method to enable or disable the auto adjust input of microphone volume.

Parameters

bEnable

True to enable auto adjust input or false to disable it.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

enableEchoCancellation:

- (ZMVideoSDKErrors) enableEchoCancellation:

(BOOL)

bEnable

Set whether to disable the function of echo cancellation or not.

Parameters

bEnable

YES means to enable.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

enableHighFidelityMusicMode:

- (ZMVideoSDKErrors) enableHighFidelityMusicMode:

(BOOL)

bEnable

Set whether to enable the function of high fidelity music mode or not.

Parameters

bEnable

YES means to enable.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

enableMicOriginalInput:

- (ZMVideoSDKErrors) enableMicOriginalInput:

(BOOL)

bEnable

Call this method to enable or disable the original input of mic.

Parameters

bEnable

YES to enable the original input of the microphone or NO to disable it.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

enableStereoAudio:

- (ZMVideoSDKErrors) enableStereoAudio:

(BOOL)

bEnable

Set whether to enable stereo audio.

Parameters

bEnable

YES means to enable.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

getEchoCancellationLevel:

- (ZMVideoSDKErrors) getEchoCancellationLevel:

(ZMVideoSDKEchoCancellationLevel *)

level

Get the echo cancellation level.

Parameters

level

The echo cancellation level.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

getSuppressBackgroundNoiseLevel:

- (ZMVideoSDKErrors) getSuppressBackgroundNoiseLevel:

(ZMVideoSDKSuppressBackgroundNoiseLevel *)

level

Get the suppress background noise level.

Parameters

level

The suppress background noise level.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

isAutoAdjustMicVolumeEnabled:

- (ZMVideoSDKErrors) isAutoAdjustMicVolumeEnabled:

(BOOL *)

bEnable

Determine whether the original input of the microphone volume is enabled.

Parameters

bEnable

YES means enabled, otherwise NO.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

isEchoCancellationEnable:

- (ZMVideoSDKErrors) isEchoCancellationEnable:

(BOOL *)

bEnable

Check whether the echo cancellation is enabled or not.

Parameters

bEnable

YES means enabled.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

isHighFidelityMusicModeEnable:

- (ZMVideoSDKErrors) isHighFidelityMusicModeEnable:

(BOOL *)

bEnable

Check whether the high fidelity music mode is enabled or not.

Parameters

bEnable

YES means enabled.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

isMicOriginalInputEnable:

- (ZMVideoSDKErrors) isMicOriginalInputEnable:

(BOOL *)

bEnable

Determine whether the original input of the microphone is enabled.

Parameters

bEnable

YES means enabled.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

isStereoAudioEnable:

- (ZMVideoSDKErrors) isStereoAudioEnable:

(BOOL *)

bEnable

Check whether the stereo audio is enabled or not.

Parameters

bEnable

YES means enabled.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

setEchoCancellationLevel:

- (ZMVideoSDKErrors) setEchoCancellationLevel:

(ZMVideoSDKEchoCancellationLevel)

level

Set the echo cancellation level.

Parameters

level

The echo cancellation level to be set.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

setSuppressBackgroundNoiseLevel:

- (ZMVideoSDKErrors) setSuppressBackgroundNoiseLevel:

(ZMVideoSDKSuppressBackgroundNoiseLevel)

level

Set the suppress background noise level.

Parameters

level

The suppress background noise level.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.