#include <zoom_video_sdk_audio_setting_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	getSuppressBackgroundNoiseLevel (ZoomVideoSDKSuppressBackgroundNoiseLevel &level)=0
	Get the suppress background noise level.

virtual ZoomVideoSDKErrors	setSuppressBackgroundNoiseLevel (ZoomVideoSDKSuppressBackgroundNoiseLevel level)=0
	Set the suppress background noise level.

virtual ZoomVideoSDKErrors	enableMicOriginalInput (bool bEnable)=0
	Call this method to enable or disable the original input of mic.

virtual ZoomVideoSDKErrors	isMicOriginalInputEnable (bool &bEnable)=0
	Determines whether the original input of the microphone is enabled.

virtual ZoomVideoSDKErrors	enableHighFidelityMusicMode (bool bEnable)=0
	Set whether to enable the function of high fidelity music mode or not.

virtual ZoomVideoSDKErrors	isHighFidelityMusicModeEnable (bool &bEnable)=0
	Check whether the high fidelity music mode is enabled or not.

virtual ZoomVideoSDKErrors	enableEchoCancellation (bool bEnable)=0
	Set whether to disable the function of echo cancellation or not.

virtual ZoomVideoSDKErrors	isEchoCancellationEnable (bool &bEnable)=0
	Check whether the echo cancellation is enabled or not.

virtual ZoomVideoSDKErrors	enableStereoAudio (bool bEnable)=0
	Enable or disable the stereo audio.

virtual ZoomVideoSDKErrors	isStereoAudioEnable (bool &bEnable)=0
	Get the flag to enable/disable the stereo audio.

virtual ZoomVideoSDKErrors	getEchoCancellationLevel (ZoomVideoSDKEchoCancellationLevel &level)=0
	Get the echo cancellation level.

virtual ZoomVideoSDKErrors	setEchoCancellationLevel (ZoomVideoSDKEchoCancellationLevel level)=0
	Set the echo cancellation level.

virtual ZoomVideoSDKErrors	enableAutoAdjustMicVolume (bool bEnable)=0
	Call this method to enable or disable the auto adjust input of microphone volume.

virtual ZoomVideoSDKErrors	isAutoAdjustMicVolumeEnabled (bool &bEnable)=0
	Determines whether the auto adjust input of the microphone volume is enabled.

Detailed Description

Definition at line 125 of file zoom_video_sdk_audio_setting_interface.h.

Member Function Documentation

◆ enableAutoAdjustMicVolume()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::enableAutoAdjustMicVolume ( bool bEnable )

pure virtual

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, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ enableEchoCancellation()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::enableEchoCancellation ( bool bEnable )

pure virtual

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

Parameters

bEnable true to enable the function, false to disable.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: This function is valid only if mic original input is enabled, otherwise invalid.

◆ enableHighFidelityMusicMode()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::enableHighFidelityMusicMode ( bool bEnable )

pure virtual

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

Parameters

bEnable true to enable the function, false to disable.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: This function is valid only if mic original input is enabled, otherwise invalid.

◆ enableMicOriginalInput()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::enableMicOriginalInput ( bool bEnable )

pure virtual

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

Parameters

bEnable true to enable the original input of microphone or false to disable it.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ enableStereoAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::enableStereoAudio ( bool bEnable )

pure virtual

Enable or disable the stereo audio.

Parameters

bEnable true indicates to enable the stereo audio.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: This function is valid only if mic original input is enabled, otherwise invalid.

◆ getEchoCancellationLevel()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::getEchoCancellationLevel ( ZoomVideoSDKEchoCancellationLevel & level )

pure virtual

Get the echo cancellation level.

Parameters

[out] level The echo cancellation level.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ getSuppressBackgroundNoiseLevel()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::getSuppressBackgroundNoiseLevel ( ZoomVideoSDKSuppressBackgroundNoiseLevel & level )

pure virtual

Get the suppress background noise level.

Parameters

[out] level The suppress background noise level.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isAutoAdjustMicVolumeEnabled()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::isAutoAdjustMicVolumeEnabled ( bool & bEnable )

pure virtual

Determines whether the auto adjust input of the microphone volume is enabled.

Parameters

[out] bEnable true if auto adjust input is enabled, otherwise false.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isEchoCancellationEnable()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::isEchoCancellationEnable ( bool & bEnable )

pure virtual

Check whether the echo cancellation is enabled or not.

Parameters

[out] bEnable true if the echo cancellation is enabled, otherwise false.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isHighFidelityMusicModeEnable()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::isHighFidelityMusicModeEnable ( bool & bEnable )

pure virtual

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

Parameters

[out] bEnable true if the high fidelity music mode is enabled, otherwise false.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isMicOriginalInputEnable()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::isMicOriginalInputEnable ( bool & bEnable )

pure virtual

Determines whether the original input of the microphone is enabled.

Parameters

[out] bEnable true if the original input of the microphone is enabled, otherwise false.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isStereoAudioEnable()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::isStereoAudioEnable ( bool & bEnable )

pure virtual

Get the flag to enable/disable the stereo audio.

Parameters

[out] bEnable true if the stereo audio is enabled, otherwise false.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ setEchoCancellationLevel()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::setEchoCancellationLevel ( ZoomVideoSDKEchoCancellationLevel level )

pure virtual

Set the echo cancellation level.

Parameters

level The new echo cancellation level to be set.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ setSuppressBackgroundNoiseLevel()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioSettingHelper::setSuppressBackgroundNoiseLevel ( ZoomVideoSDKSuppressBackgroundNoiseLevel level )

pure virtual

Set the suppress background noise level.

Parameters

level The new suppress background noise level to be set.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Public Member Functions

Detailed Description

Member Function Documentation

◆ enableAutoAdjustMicVolume()

◆ enableEchoCancellation()

◆ enableHighFidelityMusicMode()

◆ enableMicOriginalInput()

◆ enableStereoAudio()

◆ getEchoCancellationLevel()

◆ getSuppressBackgroundNoiseLevel()

◆ isAutoAdjustMicVolumeEnabled()

◆ isEchoCancellationEnable()

◆ isHighFidelityMusicModeEnable()

◆ isMicOriginalInputEnable()

◆ isStereoAudioEnable()

◆ setEchoCancellationLevel()

◆ setSuppressBackgroundNoiseLevel()