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

#include <ZMVideoSDKAudioSettingHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- getSuppressBackgroundNoiseLevel:
	Gets the suppress background noise level.

(ZMVideoSDKErrors)	- setSuppressBackgroundNoiseLevel:
	Sets the suppress background noise level.

(ZMVideoSDKErrors)	- enableMicOriginalInput:
	Enables or disables the original input of mic.

(ZMVideoSDKErrors)	- isMicOriginalInputEnable:
	Determines whether the microphone's original input is enabled.

(ZMVideoSDKErrors)	- enableHighFidelityMusicMode:
	Sets whether to enable the function of high fidelity music mode or not.

(ZMVideoSDKErrors)	- isHighFidelityMusicModeEnable:
	Checks whether the high fidelity music mode is enabled or not.

(ZMVideoSDKErrors)	- enableEchoCancellation:
	Sets whether to disable the function of echo cancellation or not.

(ZMVideoSDKErrors)	- isEchoCancellationEnable:
	Checks whether the echo cancellation is enabled or not.

(ZMVideoSDKErrors)	- enableStereoAudio:
	Sets whether to enable stereo audio.

(ZMVideoSDKErrors)	- isStereoAudioEnable:
	Checks whether the stereo audio is enabled or not.

(ZMVideoSDKErrors)	- getEchoCancellationLevel:
	Gets the echo cancellation level.

(ZMVideoSDKErrors)	- setEchoCancellationLevel:
	Sets the echo cancellation level.

(ZMVideoSDKErrors)	- enableAutoAdjustMicVolume:
	Enables or disables the auto adjust input of microphone volume.

(ZMVideoSDKErrors)	- isAutoAdjustMicVolumeEnabled:
	Determines whether the microphone's original input volume is enabled.

Detailed Description

Interface for managing audio settings in Zoom Video SDK.

Definition at line 62 of file ZMVideoSDKAudioSettingHelper.h.

Method Documentation

◆ enableAutoAdjustMicVolume:

- (ZMVideoSDKErrors) enableAutoAdjustMicVolume: (BOOL) bEnable

Enables or disables the auto adjust input of microphone volume.

Parameters

bEnable YES to enable auto adjust input, NO to disable it.

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

◆ enableEchoCancellation:

- (ZMVideoSDKErrors) enableEchoCancellation: (BOOL) bEnable

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

Parameters

bEnable YES to enable, NO to disable.

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

◆ enableHighFidelityMusicMode:

- (ZMVideoSDKErrors) enableHighFidelityMusicMode: (BOOL) bEnable

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

Parameters

bEnable YES to enable, NO to disable.

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

◆ enableMicOriginalInput:

- (ZMVideoSDKErrors) enableMicOriginalInput: (BOOL) bEnable

Enables or disables the original input of mic.

Parameters

bEnable YES to enable the microphone's original input or NO to disable it.

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

◆ enableStereoAudio:

- (ZMVideoSDKErrors) enableStereoAudio: (BOOL) bEnable

Sets whether to enable stereo audio.

Parameters

bEnable YES to enable, NO to disable.

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

◆ getEchoCancellationLevel:

- (ZMVideoSDKErrors) getEchoCancellationLevel: (ZMVideoSDKEchoCancellationLevel *) level

Gets the echo cancellation level.

Parameters

level The echo cancellation level.

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

◆ getSuppressBackgroundNoiseLevel:

- (ZMVideoSDKErrors) getSuppressBackgroundNoiseLevel: (ZMVideoSDKSuppressBackgroundNoiseLevel *) level

Gets the suppress background noise level.

Parameters

level The suppress background noise level.

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

◆ isAutoAdjustMicVolumeEnabled:

- (ZMVideoSDKErrors) isAutoAdjustMicVolumeEnabled: (BOOL *) bEnable

Determines whether the microphone's original input volume is enabled.

Parameters

bEnable YES if enabled, NO otherwise.

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

◆ isEchoCancellationEnable:

- (ZMVideoSDKErrors) isEchoCancellationEnable: (BOOL *) bEnable

Checks whether the echo cancellation is enabled or not.

Parameters

bEnable YES to enable, NO to disable.

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

◆ isHighFidelityMusicModeEnable:

- (ZMVideoSDKErrors) isHighFidelityMusicModeEnable: (BOOL *) bEnable

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

Parameters

bEnable YES to enable, NO to disable.

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

◆ isMicOriginalInputEnable:

- (ZMVideoSDKErrors) isMicOriginalInputEnable: (BOOL *) bEnable

Determines whether the microphone's original input is enabled.

Parameters

bEnable YES to enable, NO to disable.

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

◆ isStereoAudioEnable:

- (ZMVideoSDKErrors) isStereoAudioEnable: (BOOL *) bEnable

Checks whether the stereo audio is enabled or not.

Parameters

bEnable YES to enable, NO to disable.

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

◆ setEchoCancellationLevel:

- (ZMVideoSDKErrors) setEchoCancellationLevel: (ZMVideoSDKEchoCancellationLevel) level

Sets the echo cancellation level.

Parameters

level The echo cancellation level to be set.

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

◆ setSuppressBackgroundNoiseLevel:

- (ZMVideoSDKErrors) setSuppressBackgroundNoiseLevel: (ZMVideoSDKSuppressBackgroundNoiseLevel) level

Sets the suppress background noise level.

Parameters

level The suppress background noise level.

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

Instance Methods

Detailed Description

Method Documentation

◆ enableAutoAdjustMicVolume:

◆ enableEchoCancellation:

◆ enableHighFidelityMusicMode:

◆ enableMicOriginalInput:

◆ enableStereoAudio:

◆ getEchoCancellationLevel:

◆ getSuppressBackgroundNoiseLevel:

◆ isAutoAdjustMicVolumeEnabled:

◆ isEchoCancellationEnable:

◆ isHighFidelityMusicModeEnable:

◆ isMicOriginalInputEnable:

◆ isStereoAudioEnable:

◆ setEchoCancellationLevel:

◆ setSuppressBackgroundNoiseLevel: