ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IAudioSettingContext Class Referenceabstract

Audio setting interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual IList< IMicInfo *> * GetMicList ()=0
 Get the mic device list. More...
 
virtual SDKError SelectMic (const wchar_t *deviceId, const wchar_t *deviceName)=0
 Select mic device. More...
 
virtual IList< ISpeakerInfo *> * GetSpeakerList ()=0
 Get the speaker device list. More...
 
virtual SDKError SelectSpeaker (const wchar_t *deviceId, const wchar_t *deviceName)=0
 Select speaker device. More...
 
virtual SDKError EnableAutoJoinAudio (bool bEnable)=0
 Enable or disable the audio automatically when join meeting. More...
 
virtual bool IsAutoJoinAudioEnabled ()=0
 Get the flag to enable/disable the audio automatically when join meeting. More...
 
virtual SDKError EnableAutoAdjustMic (bool bEnable)=0
 Enable or disable the auto-adjust mic volume. More...
 
virtual bool IsAutoAdjustMicEnabled ()=0
 Get the flag to enable/disable to auto-adjust the mic volume. More...
 
virtual SDKError EnableStereoAudio (bool bEnable)=0
 Enable or disable the stereo audio. More...
 
virtual bool IsStereoAudioEnable ()=0
 Get the flag to enable/disable the stereo audio. More...
 
virtual SDKError EnableMicOriginalInput (bool bEnable)=0
 Enable or disable the original input of mic. More...
 
virtual bool IsMicOriginalInputEnable ()=0
 Get the flag to enable/disable the original input of mic. More...
 
virtual SDKError EnableHoldSpaceKeyToSpeak (bool bEnable)=0
 Enable or disable to press and hold the Space-bar to speak when muted. More...
 
virtual bool IsHoldSpaceKeyToSpeakEnabled ()=0
 Get the flag to enable/disable to press and hold the Space-bar to speak. More...
 
virtual SDKError EnableAlwaysMuteMicWhenJoinVoip (bool bEnable)=0
 Enable or disable to mute always the mic when join the meeting by VoiP. More...
 
virtual bool IsAlwaysMuteMicWhenJoinVoipEnabled ()=0
 Get the flag to enable/disable to mute always the mic when join the meeting by VoiP. More...
 
virtual SDKError EnableSuppressAudioNotify (bool bEnable)=0
 Enable or disable to prompt when the user joins the meeting using the third party audio. More...
 
virtual bool IsSuppressAudioNotifyEnabled ()=0
 Get the flag to enable/disable to prompt when the user joins the meeting using the third party audio. More...
 
virtual ITestAudioDeviceHelperGetTestAudioDeviceHelper ()=0
 Get the pointer to ITestAudioDeviceHelper which is used to test audio devices. More...
 
virtual SDKError SetMicVol (FLOAT &value)=0
 Set the volume of the selected mic. More...
 
virtual SDKError GetMicVol (FLOAT &value)=0
 Get the volume of the selected mic. More...
 
virtual SDKError SetSpeakerVol (FLOAT &value)=0
 Set the volume of the selected speaker. More...
 
virtual SDKError GetSpeakerVol (FLOAT &value)=0
 Get the volume of the selected speaker. More...
 
virtual SDKError SetAudioDeviceEvent (IAudioSettingContextEvent *pEvent)=0
 Audio device monitor callback event. More...
 
virtual SDKError EnableEchoCancellation (bool bEnable)=0
 Set whether to enable the function of echo cancellation or not. More...
 
virtual bool IsEchoCancellationEnabled ()=0
 Check whether the echo cancellation is enabled or not. More...
 
virtual Suppress_Background_Noise_Level GetSuppressBackgroundNoiseLevel ()=0
 
virtual SDKError SetSuppressBackgroundNoiseLevel (Suppress_Background_Noise_Level level)=0
 

Detailed Description

Audio setting interface.

Member Function Documentation

◆ EnableAlwaysMuteMicWhenJoinVoip()

virtual SDKError IAudioSettingContext::EnableAlwaysMuteMicWhenJoinVoip ( bool  bEnable)
pure virtual

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

Parameters
bEnableTRUE 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 failed. To get extended error information, see SDKError enum.

◆ EnableAutoAdjustMic()

virtual SDKError IAudioSettingContext::EnableAutoAdjustMic ( bool  bEnable)
pure virtual

Enable or disable the auto-adjust mic volume.

Parameters
bEnableTRUE indicates to enable to auto-adjust the mic volume.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableAutoJoinAudio()

virtual SDKError IAudioSettingContext::EnableAutoJoinAudio ( bool  bEnable)
pure virtual

Enable or disable the audio automatically when join meeting.

Parameters
bEnableTRUE indicates to enable the audio automatically when join meeting.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableEchoCancellation()

virtual SDKError IAudioSettingContext::EnableEchoCancellation ( bool  bEnable)
pure virtual

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

Parameters
bEnableTrue means to enable the function, FALSE not.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHoldSpaceKeyToSpeak()

virtual SDKError IAudioSettingContext::EnableHoldSpaceKeyToSpeak ( bool  bEnable)
pure virtual

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

Parameters
bEnableTRUE indicates to press and hold the Space-bar to speak.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableMicOriginalInput()

virtual SDKError IAudioSettingContext::EnableMicOriginalInput ( bool  bEnable)
pure virtual

Enable or disable the original input of mic.

Parameters
bEnableTRUE indicates to enable the original input of mic.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableStereoAudio()

virtual SDKError IAudioSettingContext::EnableStereoAudio ( bool  bEnable)
pure virtual

Enable or disable the stereo audio.

Parameters
bEnableTRUE indicates to enable the stereo audio.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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
bEnableTRUE indicates to enable to prompt.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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 failed, returns NULL.

◆ 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.

◆ 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 failed, returns NULL.

◆ 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.

◆ 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 failed, returns NULL. For more details, see ITestAudioDeviceHelper.

◆ 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.

◆ 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.

◆ IsEchoCancellationEnabled()

virtual bool IAudioSettingContext::IsEchoCancellationEnabled ( )
pure virtual

Check whether the echo cancellation 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.

◆ 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.

◆ SelectMic()

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

Select mic device.

Parameters
deviceIdSpecify the device to be selected.
deviceNameSpecify the device name assigned by deviceId.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SelectSpeaker()

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

Select speaker device.

Parameters
deviceIdSpecify the device to be selected.
deviceNameSpecify the device the device name assigned by deviceId.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetAudioDeviceEvent()

virtual SDKError IAudioSettingContext::SetAudioDeviceEvent ( IAudioSettingContextEvent pEvent)
pure virtual

Audio device monitor callback event.

Parameters
pEventA 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. To get extended error information, see SDKError enum. For more details, see IAudioSettingContextEvent.
Remarks
You must call the function if you want to monitor the audio device plugged in/out.

◆ SetMicVol()

virtual SDKError IAudioSettingContext::SetMicVol ( FLOAT &  value)
pure virtual

Set the volume of the selected mic.

Parameters
valueSpecify the volume of the mic that varies between 0 and 255. The SDK will enable the default mic if there is no mic selected via SelectMic().

◆ SetSpeakerVol()

virtual SDKError IAudioSettingContext::SetSpeakerVol ( FLOAT &  value)
pure virtual

Set the volume of the selected speaker.

Parameters
valueSpecify the volume of the speaker that varies between 0 and 255. The SDK will enable the default speaker if there is no speaker selected via SelectSpeaker.

The documentation for this class was generated from the following file: