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
	Selects a mic device.
virtual IList< ISpeakerInfo * > *	GetSpeakerList ()=0
	Gets the speaker device list.
virtual SDKError	SelectSpeaker (const zchar_t deviceId, const zchar_t deviceName)=0
	Selects a speaker device.
virtual SDKError	EnableAutoJoinAudio (bool bEnable)=0
	Enables or disables automatically joining audio when joining the meeting.
virtual bool	IsAutoJoinAudioEnabled ()=0
	Determines whether automatically joining audio when joining the meeting is enabled.
virtual SDKError	EnableAutoAdjustMic (bool bEnable)=0
	Enables or disables auto-adjusting mic volume.
virtual bool	IsAutoAdjustMicEnabled ()=0
	Determines whether auto-adjusting mic volume is enabled.
virtual SDKError	EnableAlwaysMuteMicWhenJoinVoip (bool bEnable)=0
	Enables or disables always muting the mic when joining the meeting by VoIP.
virtual bool	IsAlwaysMuteMicWhenJoinVoipEnabled ()=0
	Determines whether always muting the mic when joining the meeting by VoIP is enabled.
virtual SDKError	EnableSuppressAudioNotify (bool bEnable)=0
	Enables or disables prompting when the user joins the meeting using third party audio.
virtual bool	IsSuppressAudioNotifyEnabled ()=0
	Determines whether prompting when the user joins the meeting using third party audio is enabled.
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
	Sets the 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
	Enables or disables disabling echo cancellation.
virtual bool	IsEchoCancellationDisabled ()=0
	Determines whether echo cancellation is disabled.
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 disables the original input of mic.

Detailed Description

Audio setting interface.

Definition at line 1361 of file setting_service_interface.h.

Member Function Documentation

◆ DisableEchoCancellation()

virtual SDKError IAudioSettingContext::DisableEchoCancellation ( bool bDisable )

pure virtual

Enables or disables disabling echo cancellation.

Parameters

bDisable true to disable echo cancellation, false to enable.

Returns: If the function succeeds, it returns 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 disables always muting the mic when joining the meeting by VoIP.

Parameters

bEnable true to enable, false to disable.

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

◆ EnableAutoAdjustMic()

virtual SDKError IAudioSettingContext::EnableAutoAdjustMic ( bool bEnable )

pure virtual

Enables or disables auto-adjusting mic volume.

Parameters

bEnable true to enable, false to disable.

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

◆ EnableAutoJoinAudio()

virtual SDKError IAudioSettingContext::EnableAutoJoinAudio ( bool bEnable )

pure virtual

Enables or disables automatically joining audio when joining the meeting.

Parameters

bEnable true to enable, false to disable.

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

◆ EnableMicOriginalInput()

virtual SDKError IAudioSettingContext::EnableMicOriginalInput ( bool bEnable )

pure virtual

Enables or disables the original input of mic.

Parameters

bEnable true to enable, false to disable.

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

◆ EnableSuppressAudioNotify()

virtual SDKError IAudioSettingContext::EnableSuppressAudioNotify ( bool bEnable )

pure virtual

Enables or disables prompting when the user joins the meeting using third party audio.

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns 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 echo cancellation level.

◆ GetMicList()

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

pure virtual

Gets the mic device list.

Returns: If the function succeeds, it returns the mic device list. Otherwise, this function fails and returns nullptr.

◆ GetMicVol()

virtual SDKError IAudioSettingContext::GetMicVol ( FLOAT & value )

pure virtual

Gets the volume of the selected mic.

Parameters

value The current volume of the mic.

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

◆ 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, it returns the speaker device list. Otherwise, this function fails and returns nullptr.

◆ GetSpeakerVol()

virtual SDKError IAudioSettingContext::GetSpeakerVol ( FLOAT & value )

pure virtual

Gets the volume of the selected speaker.

Parameters

value The current volume of the speaker.

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

◆ 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

Determines whether always muting the mic when joining the meeting by VoIP is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsAutoAdjustMicEnabled()

virtual bool IAudioSettingContext::IsAutoAdjustMicEnabled ( )

pure virtual

Determines whether auto-adjusting mic volume is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsAutoJoinAudioEnabled()

virtual bool IAudioSettingContext::IsAutoJoinAudioEnabled ( )

pure virtual

Determines whether automatically joining audio when joining the meeting is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsEchoCancellationDisabled()

virtual bool IAudioSettingContext::IsEchoCancellationDisabled ( )

pure virtual

Determines whether echo cancellation is disabled.

Returns: true if echo cancellation is disabled. Otherwise, false.

◆ IsSuppressAudioNotifyEnabled()

virtual bool IAudioSettingContext::IsSuppressAudioNotifyEnabled ( )

pure virtual

Determines whether prompting when the user joins the meeting using third party audio is enabled.

Returns: true if enabled. Otherwise, false.

◆ SelectMic()

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

pure virtual

Selects a mic device.

Parameters

deviceId	The device ID to be selected.
deviceName	The device name assigned by deviceId.

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

◆ SelectSpeaker()

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

pure virtual

Selects a speaker device.

Parameters

deviceId	The device ID to be selected.
deviceName	The device name assigned by deviceId.

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

◆ SetAudioDeviceEvent()

virtual SDKError IAudioSettingContext::SetAudioDeviceEvent ( IAudioSettingContextEvent * pEvent )

pure virtual

Sets the audio device monitor callback event.

Parameters

pEvent A pointer to the IAudioSettingContextEvent that receives audio device plugged in or out events.

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

Note: You must call this function if you want to monitor the audio device plugged in or 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, it returns 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, it returns 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 The volume of the mic that ranges from 0 to 255.

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

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 The volume of the speaker that ranges from 0 to 255.

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

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, it returns 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()