Meeting SDK for Windows API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ITestAudioDeviceHelperEvent Class Referenceabstract

Audio device testing callback events. More...

#include <setting_service_interface.h>

Public Member Functions

virtual ~ITestAudioDeviceHelperEvent ()
 
virtual void OnMicSpkVolumeChanged (unsigned int MicVolume, unsigned int SpkVolume)=0
 Notify the current mic or speaker volume when testing.
 
virtual void OnNoAudioDeviceIsUseful (bool bMicOrSpk)=0
 Notify that either mic device or speaker device is not found.
 
virtual void OnTestMicStatusChanged (SDK_TESTMIC_STATUS status, bool &bHandled)=0
 Notify the mic status when testing.
 
virtual void OnSelectedAudioDeviceIsChanged ()=0
 Notify the user that a mic/speaker device is selected when testing. Then the SDK will close the mic/speaker testing. The user shall restart the test manually if he still wants to test.
 

Detailed Description

Audio device testing callback events.

Definition at line 290 of file setting_service_interface.h.

Constructor & Destructor Documentation

◆ ~ITestAudioDeviceHelperEvent()

virtual ITestAudioDeviceHelperEvent::~ITestAudioDeviceHelperEvent ( )
inlinevirtual

Definition at line 293 of file setting_service_interface.h.

293{}

Member Function Documentation

◆ OnMicSpkVolumeChanged()

virtual void ITestAudioDeviceHelperEvent::OnMicSpkVolumeChanged ( unsigned int MicVolume,
unsigned int SpkVolume )
pure virtual

Notify the current mic or speaker volume when testing.

Parameters
MicVolumeSpecify the volume of the mic.
SpkVolumeSpecify the volume of the speaker.

◆ OnNoAudioDeviceIsUseful()

virtual void ITestAudioDeviceHelperEvent::OnNoAudioDeviceIsUseful ( bool bMicOrSpk)
pure virtual

Notify that either mic device or speaker device is not found.

Parameters
bMicOrSpkTRUE indicates no mic device. False no speaker device.

◆ OnSelectedAudioDeviceIsChanged()

virtual void ITestAudioDeviceHelperEvent::OnSelectedAudioDeviceIsChanged ( )
pure virtual

Notify the user that a mic/speaker device is selected when testing. Then the SDK will close the mic/speaker testing. The user shall restart the test manually if he still wants to test.

◆ OnTestMicStatusChanged()

virtual void ITestAudioDeviceHelperEvent::OnTestMicStatusChanged ( SDK_TESTMIC_STATUS status,
bool & bHandled )
pure virtual

Notify the mic status when testing.

Parameters
statusThe mic status. For more details, see SDK_TESTMIC_STATUS enum.
bHandledThe SDK default logic won't handle the mic status the value is set to be TRUE. For more details, see SDK_TESTMIC_STATUS.
Remarks
The enuCanPlay status indicates that the SDK has recorded the microphone sound for the longest time (6 seconds). If the bHandled is not set to TURE hereby, the SDK will call TestMicStopTesting() itself.