Audio setting interface. More...

#include <setting_service_interface.h>

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

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

virtual IList< ISpeakerInfo * > *	GetSpeakerList ()=0
	Gets 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
	Enables or disable the audio automatically when join meeting.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual bool	IsEchoCancellationDisabled ()=0
	Checks 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
	Enables or disable the original input of mic.

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

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

Parameters

bDisable true indicates to disable the function, false not.

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

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

◆ EnableAlwaysMuteMicWhenJoinVoip()

virtual SDKError IAudioSettingContext::EnableAlwaysMuteMicWhenJoinVoip ( bool bEnable )

pure virtual

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

Parameters

bEnable true indicates 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, this function returns an error.

◆ EnableAutoAdjustMic()

virtual SDKError IAudioSettingContext::EnableAutoAdjustMic ( bool bEnable )

pure virtual

Enables or disable the auto-adjust mic volume.

Parameters

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

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

◆ EnableAutoJoinAudio()

virtual SDKError IAudioSettingContext::EnableAutoJoinAudio ( bool bEnable )

pure virtual

Enables or disable the audio automatically when join meeting.

Parameters

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

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

◆ EnableMicOriginalInput()

virtual SDKError IAudioSettingContext::EnableMicOriginalInput ( bool bEnable )

pure virtual

Enables or disable the original input of mic.

Parameters

bEnable true indicates to enable the original input of mic.

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

◆ EnableSuppressAudioNotify()

virtual SDKError IAudioSettingContext::EnableSuppressAudioNotify ( bool bEnable )

pure virtual

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

Parameters

bEnable true indicates to enable to prompt.

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

◆ GetAudioSignalProcessType()

virtual SDK_AUDIO_DEVICE_RAW_MODE_TYPE IAudioSettingContext::GetAudioSignalProcessType ( )

pure virtual

Gets the audio device raw mode type.

Returns: The audio device raw mode type.

◆ GetEchoCancellationLevel()

virtual SDK_ECHO_CANCELLATION_LEVEL IAudioSettingContext::GetEchoCancellationLevel ( )

pure virtual

Gets the echo cancellation level.

Returns: The the echo cancellation level.

◆ GetMicList()

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

pure virtual

Gets 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

Gets 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

Gets 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

Gets 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

Gets the suppress background noise level.

Returns: The suppress background noise level.

◆ IsAlwaysMuteMicWhenJoinVoipEnabled()

virtual bool IAudioSettingContext::IsAlwaysMuteMicWhenJoinVoipEnabled ( )

pure virtual

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

Returns: true indicates that this is enabled.

◆ IsAutoAdjustMicEnabled()

virtual bool IAudioSettingContext::IsAutoAdjustMicEnabled ( )

pure virtual

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

Returns: true indicates that this is enabled.

◆ IsAutoJoinAudioEnabled()

virtual bool IAudioSettingContext::IsAutoJoinAudioEnabled ( )

pure virtual

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

Returns: true indicates that this is enabled.

◆ IsEchoCancellationDisabled()

virtual bool IAudioSettingContext::IsEchoCancellationDisabled ( )

pure virtual

Checks whether the echo cancellation is disabled or not.

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

◆ IsSuppressAudioNotifyEnabled()

virtual bool IAudioSettingContext::IsSuppressAudioNotifyEnabled ( )

pure virtual

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

Returns: true indicates that this 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, this function returns an error.

◆ 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, this function returns an error.

◆ 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, this function returns an error.

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

Sets 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, this function returns an error.

◆ SetEchoCancellationLevel()

virtual SDKError IAudioSettingContext::SetEchoCancellationLevel ( SDK_ECHO_CANCELLATION_LEVEL level )

pure virtual

Sets 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, this function returns an error.

◆ SetMicVol()

virtual SDKError IAudioSettingContext::SetMicVol ( FLOAT & value )

pure virtual

Sets 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

Sets 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

Sets 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, this function returns an error.

◆ UseDefaultSystemMic()

virtual SDKError IAudioSettingContext::UseDefaultSystemMic ( )

pure virtual

◆ UseDefaultSystemSpeaker()

virtual SDKError IAudioSettingContext::UseDefaultSystemSpeaker ( )

pure virtual

Public Member Functions

Detailed Description

Member Function Documentation

◆ DisableEchoCancellation()

◆ EnableAlwaysMuteMicWhenJoinVoip()

◆ EnableAutoAdjustMic()

◆ EnableAutoJoinAudio()

◆ EnableMicOriginalInput()

◆ EnableSuppressAudioNotify()

◆ GetAudioSignalProcessType()

◆ GetEchoCancellationLevel()

◆ GetMicList()

◆ GetMicVol()

◆ GetRingSpkList()

◆ GetRingSpkVolume()

◆ GetSpeakerList()

◆ GetSpeakerVol()

◆ GetSuppressBackgroundNoiseLevel()

◆ IsAlwaysMuteMicWhenJoinVoipEnabled()

◆ IsAutoAdjustMicEnabled()

◆ IsAutoJoinAudioEnabled()

◆ IsEchoCancellationDisabled()

◆ IsSuppressAudioNotifyEnabled()

◆ SelectMic()

◆ SelectSpeaker()

◆ SetAudioDeviceEvent()

◆ SetAudioSignalProcessType()

◆ SetEchoCancellationLevel()

◆ SetMicVol()

◆ SetRingSpkDevice()

◆ SetRingSpkVolume()

◆ SetSpeakerVol()

◆ SetSuppressBackgroundNoiseLevel()

◆ UseDefaultSystemMic()

◆ UseDefaultSystemSpeaker()