Audio setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual IList< IMicInfo * > *	GetMicList ()=0
	Get the mic device list.

virtual SDKError	SelectMic (const zchar_t deviceId, const zchar_t deviceName)=0
	Select mic device.

virtual IList< ISpeakerInfo * > *	GetSpeakerList ()=0
	Get the speaker device list.

virtual SDKError	SelectSpeaker (const zchar_t deviceId, const zchar_t deviceName)=0
	Select speaker device.

virtual SDKError	EnableAutoJoinAudio (bool bEnable)=0
	Enable or disable the audio automatically when join meeting.

virtual bool	IsAutoJoinAudioEnabled ()=0
	Get the flag to enable/disable the audio automatically when join meeting.

virtual SDKError	EnableAutoAdjustMic (bool bEnable)=0
	Enable or disable the auto-adjust mic volume.

virtual bool	IsAutoAdjustMicEnabled ()=0
	Get the flag to enable/disable to auto-adjust the mic volume.

virtual SDKError	EnableAlwaysMuteMicWhenJoinVoip (bool bEnable)=0
	Enable or disable to mute always the mic when join the meeting by VoiP.

virtual bool	IsAlwaysMuteMicWhenJoinVoipEnabled ()=0
	Get the flag to enable/disable to mute always the mic when join the meeting by VoiP.

virtual SDKError	EnableSuppressAudioNotify (bool bEnable)=0
	Enable or disable to prompt when the user joins the meeting using the third party audio.

virtual bool	IsSuppressAudioNotifyEnabled ()=0
	Get the flag to enable/disable to prompt when the user joins the meeting using the third party audio.

virtual SDKError	SetMicVol (FLOAT &value)=0
	Set the volume of the selected mic.

virtual SDKError	GetMicVol (FLOAT &value)=0
	Get the volume of the selected mic.

virtual SDKError	SetSpeakerVol (FLOAT &value)=0
	Set the volume of the selected speaker.

virtual SDKError	GetSpeakerVol (FLOAT &value)=0
	Get the volume of the selected speaker.

virtual SDKError	SetAudioDeviceEvent (IAudioSettingContextEvent *pEvent)=0
	Audio device monitor callback event.

virtual SDK_ECHO_CANCELLATION_LEVEL	GetEchoCancellationLevel ()=0
	Get the echo cancellation level.

virtual SDKError	SetEchoCancellationLevel (SDK_ECHO_CANCELLATION_LEVEL level)=0
	Set the echo cancellation level.

virtual Suppress_Background_Noise_Level	GetSuppressBackgroundNoiseLevel ()=0
	Get the suppress background noise level.

virtual SDKError	SetSuppressBackgroundNoiseLevel (Suppress_Background_Noise_Level level)=0
	Set the suppress background noise level.

virtual SDK_AUDIO_DEVICE_RAW_MODE_TYPE	GetAudioSignalProcessType ()=0
	Get the audio device raw mode type.

virtual SDKError	SetAudioSignalProcessType (SDK_AUDIO_DEVICE_RAW_MODE_TYPE type)=0
	Set the audio device raw mode type.

virtual SDKError	DisableEchoCancellation (bool bDisable)=0
	Set whether to disable the function of echo cancellation or not.

virtual bool	IsEchoCancellationDisabled ()=0
	Check whether the echo cancellation is disabled or not.

virtual IList< IRingSpeakerInfo * > *	GetRingSpkList ()=0

virtual SDKError	GetRingSpkVolume (FLOAT &fValue)=0

virtual SDKError	SetRingSpkVolume (FLOAT fValue)=0

virtual SDKError	SetRingSpkDevice (const zchar_t *spk_id)=0

virtual SDKError	UseDefaultSystemMic ()=0

virtual SDKError	UseDefaultSystemSpeaker ()=0

virtual SDKError	EnableMicOriginalInput (bool bEnable)=0
	Enable or disable the original input of mic.

virtual SDKError	EnableStereoAudio (bool bEnable)=0
	Enable or disable the stereo audio.

virtual bool	IsStereoAudioEnable ()=0
	Get the flag to enable/disable the stereo audio.

virtual bool	IsMicOriginalInputEnable ()=0
	Get the flag to enable/disable the original input of mic.

virtual SDKError	EnableHoldSpaceKeyToSpeak (bool bEnable)=0
	Enable or disable to press and hold the Space-bar to speak when muted.

virtual bool	IsHoldSpaceKeyToSpeakEnabled ()=0
	Get the flag to enable/disable to press and hold the Space-bar to speak.

virtual ITestAudioDeviceHelper *	GetTestAudioDeviceHelper ()=0
	Get the pointer to ITestAudioDeviceHelper which is used to test audio devices.

virtual SDKError	EnableSyncButtonsOnHeadset (bool bEnable)=0
	Set whether to enable the function of sync buttons on headset or not.

virtual bool	IsSyncButtonsOnHeadsetEnabled ()=0
	Check whether the sync buttons on headset is enabled or not.

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

virtual bool	IsHighFidelityMusicModeDisabled ()=0
	Check whether the high fidelity music mode is enabled or not.

virtual SDKError	EnableAlwaysUseSeparateRingSpk (bool bEnable)=0

virtual bool	IsAlwaysUseSeparateRingSpk ()=0

virtual bool	isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio ()=0

Detailed Description

Audio setting interface.

Definition at line 1365 of file setting_service_interface.h.

Member Function Documentation

◆ DisableEchoCancellation()

virtual SDKError IAudioSettingContext::DisableEchoCancellation ( bool bDisable )

pure virtual

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

Parameters

bDisable True means to disable the function, FALSE not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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

◆ EnableAlwaysMuteMicWhenJoinVoip()

virtual SDKError IAudioSettingContext::EnableAlwaysMuteMicWhenJoinVoip ( bool bEnable )

pure virtual

Enable or disable to mute always the mic when join the meeting by VoiP.

Parameters

bEnable true means to enable to mute always the mic when join the meeting by VoiP.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableAlwaysUseSeparateRingSpk()

virtual SDKError IAudioSettingContext::EnableAlwaysUseSeparateRingSpk ( bool bEnable )

pure virtual

◆ EnableAutoAdjustMic()

virtual SDKError IAudioSettingContext::EnableAutoAdjustMic ( bool bEnable )

pure virtual

Enable or disable the auto-adjust mic volume.

Parameters

bEnable true means to enable to auto-adjust the mic volume.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableAutoJoinAudio()

virtual SDKError IAudioSettingContext::EnableAutoJoinAudio ( bool bEnable )

pure virtual

Enable or disable the audio automatically when join meeting.

Parameters

bEnable true means to enable the audio automatically when join meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableHighFidelityMusicMode()

virtual SDKError IAudioSettingContext::EnableHighFidelityMusicMode ( bool bEnable )

pure virtual

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

Parameters

bEnable true means to enable the function, FALSE not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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

◆ EnableHoldSpaceKeyToSpeak()

virtual SDKError IAudioSettingContext::EnableHoldSpaceKeyToSpeak ( bool bEnable )

pure virtual

Enable or disable to press and hold the Space-bar to speak when muted.

Parameters

bEnable true means to press and hold the Space-bar to speak.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableMicOriginalInput()

virtual SDKError IAudioSettingContext::EnableMicOriginalInput ( bool bEnable )

pure virtual

Enable or disable the original input of mic.

Parameters

bEnable true means to enable the original input of mic.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableStereoAudio()

virtual SDKError IAudioSettingContext::EnableStereoAudio ( bool bEnable )

pure virtual

Enable or disable the stereo audio.

Parameters

bEnable true means to enable the stereo audio.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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

◆ EnableSuppressAudioNotify()

virtual SDKError IAudioSettingContext::EnableSuppressAudioNotify ( bool bEnable )

pure virtual

Enable or disable to prompt when the user joins the meeting using the third party audio.

Parameters

bEnable true means to enable to prompt.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableSyncButtonsOnHeadset()

virtual SDKError IAudioSettingContext::EnableSyncButtonsOnHeadset ( bool bEnable )

pure virtual

Set whether to enable the function of sync buttons on headset or not.

Parameters

bEnable true means to enable the function, FALSE not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ GetAudioSignalProcessType()

virtual SDK_AUDIO_DEVICE_RAW_MODE_TYPE IAudioSettingContext::GetAudioSignalProcessType ( )

pure virtual

Get the audio device raw mode type.

Returns: The audio device raw mode type.

◆ GetEchoCancellationLevel()

virtual SDK_ECHO_CANCELLATION_LEVEL IAudioSettingContext::GetEchoCancellationLevel ( )

pure virtual

Get the echo cancellation level.

Returns: The the echo cancellation level.

◆ GetMicList()

virtual IList< IMicInfo * > * IAudioSettingContext::GetMicList ( )

pure virtual

Get the mic device list.

Returns: If the function succeeds, the return value is the camera device list. Otherwise returns nullptr.

◆ GetMicVol()

virtual SDKError IAudioSettingContext::GetMicVol ( FLOAT & value )

pure virtual

Get the volume of the selected mic.

Parameters

value [out] Specify the current volume of the mic.

◆ GetRingSpkList()

virtual IList< IRingSpeakerInfo * > * IAudioSettingContext::GetRingSpkList ( )

pure virtual

◆ GetRingSpkVolume()

virtual SDKError IAudioSettingContext::GetRingSpkVolume ( FLOAT & fValue )

pure virtual

◆ GetSpeakerList()

virtual IList< ISpeakerInfo * > * IAudioSettingContext::GetSpeakerList ( )

pure virtual

Get the speaker device list.

Returns: If the function succeeds, the return value is the camera device list. Otherwise returns nullptr.

◆ GetSpeakerVol()

virtual SDKError IAudioSettingContext::GetSpeakerVol ( FLOAT & value )

pure virtual

Get the volume of the selected speaker.

Parameters

value [out] Specify the current volume of the speaker.

◆ GetSuppressBackgroundNoiseLevel()

virtual Suppress_Background_Noise_Level IAudioSettingContext::GetSuppressBackgroundNoiseLevel ( )

pure virtual

Get the suppress background noise level.

Returns: The suppress background noise level.

◆ GetTestAudioDeviceHelper()

virtual ITestAudioDeviceHelper * IAudioSettingContext::GetTestAudioDeviceHelper ( )

pure virtual

Get the pointer to ITestAudioDeviceHelper which is used to test audio devices.

Returns: If the function succeeds, the return value is the pointer to ITestAudioDeviceHelper. Otherwise returns nullptr.

◆ IsAlwaysMuteMicWhenJoinVoipEnabled()

virtual bool IAudioSettingContext::IsAlwaysMuteMicWhenJoinVoipEnabled ( )

pure virtual

Get the flag to enable/disable to mute always the mic when join the meeting by VoiP.

Returns: Enabled or disabled.

◆ IsAlwaysUseSeparateRingSpk()

virtual bool IAudioSettingContext::IsAlwaysUseSeparateRingSpk ( )

pure virtual

◆ IsAutoAdjustMicEnabled()

virtual bool IAudioSettingContext::IsAutoAdjustMicEnabled ( )

pure virtual

Get the flag to enable/disable to auto-adjust the mic volume.

Returns: Enabled or disabled.

◆ IsAutoJoinAudioEnabled()

virtual bool IAudioSettingContext::IsAutoJoinAudioEnabled ( )

pure virtual

Get the flag to enable/disable the audio automatically when join meeting.

Returns: Enabled or disabled.

◆ IsEchoCancellationDisabled()

virtual bool IAudioSettingContext::IsEchoCancellationDisabled ( )

pure virtual

Check whether the echo cancellation is disabled or not.

Returns: If it is true, it means the echo cancellation is disabled

◆ IsHighFidelityMusicModeDisabled()

virtual bool IAudioSettingContext::IsHighFidelityMusicModeDisabled ( )

pure virtual

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

Returns: If it is true, it means the echo cancellation is enabled

◆ IsHoldSpaceKeyToSpeakEnabled()

virtual bool IAudioSettingContext::IsHoldSpaceKeyToSpeakEnabled ( )

pure virtual

Get the flag to enable/disable to press and hold the Space-bar to speak.

Returns: Enabled or disabled.

◆ IsMicOriginalInputEnable()

virtual bool IAudioSettingContext::IsMicOriginalInputEnable ( )

pure virtual

Get the flag to enable/disable the original input of mic.

Returns: Enabled or disabled.

◆ IsStereoAudioEnable()

virtual bool IAudioSettingContext::IsStereoAudioEnable ( )

pure virtual

Get the flag to enable/disable the stereo audio.

Returns: Enabled or disabled.

◆ isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio()

virtual bool IAudioSettingContext::isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio ( )

pure virtual

◆ IsSuppressAudioNotifyEnabled()

virtual bool IAudioSettingContext::IsSuppressAudioNotifyEnabled ( )

pure virtual

Get the flag to enable/disable to prompt when the user joins the meeting using the third party audio.

Returns: Enabled or disabled.

◆ IsSyncButtonsOnHeadsetEnabled()

virtual bool IAudioSettingContext::IsSyncButtonsOnHeadsetEnabled ( )

pure virtual

Check whether the sync buttons on headset is enabled or not.

Returns: If it is true, it means the sync buttons on headset is enabled.

◆ SelectMic()

virtual SDKError IAudioSettingContext::SelectMic	(	const zchar_t *	deviceId,
		const zchar_t *	deviceName )

pure virtual

Select mic device.

Parameters

deviceId	Specify the device to be selected.
deviceName	Specify the device name assigned by deviceId.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SelectSpeaker()

virtual SDKError IAudioSettingContext::SelectSpeaker	(	const zchar_t *	deviceId,
		const zchar_t *	deviceName )

pure virtual

Select speaker device.

Parameters

deviceId	Specify the device to be selected.
deviceName	Specify the device the device name assigned by deviceId.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetAudioDeviceEvent()

virtual SDKError IAudioSettingContext::SetAudioDeviceEvent ( IAudioSettingContextEvent * pEvent )

pure virtual

Audio device monitor callback event.

Parameters

pEvent A pointer to the IAudioSettingContextEvent that receives audio device plugged in/out event.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Note: You must call the function if you want to monitor the audio device plugged in/out.

◆ SetAudioSignalProcessType()

virtual SDKError IAudioSettingContext::SetAudioSignalProcessType ( SDK_AUDIO_DEVICE_RAW_MODE_TYPE type )

pure virtual

Set the audio device raw mode type.

Parameters

type	The new audio device raw mode type to be set.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetEchoCancellationLevel()

virtual SDKError IAudioSettingContext::SetEchoCancellationLevel ( SDK_ECHO_CANCELLATION_LEVEL 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 SDKERR_SUCCESS. Otherwise failed.

◆ SetMicVol()

virtual SDKError IAudioSettingContext::SetMicVol ( FLOAT & value )

pure virtual

Set the volume of the selected mic.

Parameters

value Specify the volume of the mic that varies between 0 and 255.

Note: The SDK will enable the default mic if there is no mic selected via SelectMic().

◆ SetRingSpkDevice()

virtual SDKError IAudioSettingContext::SetRingSpkDevice ( const zchar_t * spk_id )

pure virtual

◆ SetRingSpkVolume()

virtual SDKError IAudioSettingContext::SetRingSpkVolume ( FLOAT fValue )

pure virtual

◆ SetSpeakerVol()

virtual SDKError IAudioSettingContext::SetSpeakerVol ( FLOAT & value )

pure virtual

Set the volume of the selected speaker.

Parameters

value Specify the volume of the speaker that varies between 0 and 255.

Note: The SDK will enable the default speaker if there is no speaker selected via SelectSpeaker.

◆ SetSuppressBackgroundNoiseLevel()

virtual SDKError IAudioSettingContext::SetSuppressBackgroundNoiseLevel ( Suppress_Background_Noise_Level 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 SDKERR_SUCCESS. Otherwise failed.

◆ UseDefaultSystemMic()

virtual SDKError IAudioSettingContext::UseDefaultSystemMic ( )

pure virtual

◆ UseDefaultSystemSpeaker()

virtual SDKError IAudioSettingContext::UseDefaultSystemSpeaker ( )

pure virtual

Public Member Functions

Detailed Description

Member Function Documentation

◆ DisableEchoCancellation()

◆ EnableAlwaysMuteMicWhenJoinVoip()

◆ EnableAlwaysUseSeparateRingSpk()

◆ EnableAutoAdjustMic()

◆ EnableAutoJoinAudio()

◆ EnableHighFidelityMusicMode()

◆ EnableHoldSpaceKeyToSpeak()

◆ EnableMicOriginalInput()

◆ EnableStereoAudio()

◆ EnableSuppressAudioNotify()

◆ EnableSyncButtonsOnHeadset()

◆ GetAudioSignalProcessType()

◆ GetEchoCancellationLevel()

◆ GetMicList()

◆ GetMicVol()

◆ GetRingSpkList()

◆ GetRingSpkVolume()

◆ GetSpeakerList()

◆ GetSpeakerVol()

◆ GetSuppressBackgroundNoiseLevel()

◆ GetTestAudioDeviceHelper()

◆ IsAlwaysMuteMicWhenJoinVoipEnabled()

◆ IsAlwaysUseSeparateRingSpk()

◆ IsAutoAdjustMicEnabled()

◆ IsAutoJoinAudioEnabled()

◆ IsEchoCancellationDisabled()

◆ IsHighFidelityMusicModeDisabled()

◆ IsHoldSpaceKeyToSpeakEnabled()

◆ IsMicOriginalInputEnable()

◆ IsStereoAudioEnable()

◆ isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio()

◆ IsSuppressAudioNotifyEnabled()

◆ IsSyncButtonsOnHeadsetEnabled()

◆ SelectMic()

◆ SelectSpeaker()

◆ SetAudioDeviceEvent()

◆ SetAudioSignalProcessType()

◆ SetEchoCancellationLevel()

◆ SetMicVol()

◆ SetRingSpkDevice()

◆ SetRingSpkVolume()

◆ SetSpeakerVol()

◆ SetSuppressBackgroundNoiseLevel()

◆ UseDefaultSystemMic()

◆ UseDefaultSystemSpeaker()