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

Audio device test interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual SDKError SetEvent (ITestAudioDeviceHelperEvent *pEvent)=0
 Audio device test callback handler. More...
 
virtual SDKError TestMicStartRecording (const wchar_t *deviceID=NULL)=0
 Start to test the mic. More...
 
virtual SDKError TestMicStopTesting ()=0
 Stop the mic test. The SDK will return an error if there is no mic test. More...
 
virtual SDKError TestMicPlayRecording ()=0
 Play the mic recorded sound. If there is no mic testing, SDK return an error. More...
 
virtual SDKError TestSpeakerStartPlaying (const wchar_t *deviceID=NULL)=0
 Start to test the speaker. More...
 
virtual SDKError TestSpeakerStopPlaying ()=0
 Stop the speaker test. The SDK will return an error if there is no speaker test. More...
 
virtual SDKError SetTimerInterval (unsigned int timerInterval)=0
 Set the time interval for audio test. More...
 

Detailed Description

Audio device test interface.

Member Function Documentation

◆ SetEvent()

virtual SDKError ITestAudioDeviceHelper::SetEvent ( ITestAudioDeviceHelperEvent pEvent)
pure virtual

Audio device test callback handler.

Parameters
pEventA pointer to the ITestAudioDeviceHelperEvent that receives audio device test event.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Call the function before using any other interface of the same class.

◆ SetTimerInterval()

virtual SDKError ITestAudioDeviceHelper::SetTimerInterval ( unsigned int  timerInterval)
pure virtual

Set the time interval for audio test.

Parameters
timerIntervalUsually the SDK sends the mic and speaker volumes every 200 ms by default via ITestAudioDeviceHelperEvent::OnMicSpkVolumnChanged(). With this function, the user can modify the time interval instead of 200. The time interval varies only from 50 to 1000 in millisecond.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
This interface will stop the mic/speaker test(if there is). It is suggested to call it before audio test.

◆ TestMicPlayRecording()

virtual SDKError ITestAudioDeviceHelper::TestMicPlayRecording ( )
pure virtual

Play the mic recorded sound. If there is no mic testing, SDK return an error.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
The function is disabled if no event handler is set.

◆ TestMicStartRecording()

virtual SDKError ITestAudioDeviceHelper::TestMicStartRecording ( const wchar_t *  deviceID = NULL)
pure virtual

Start to test the mic.

Parameters
deviceIDSpecify to test a mic device. If the param is a wrong mic ID, the SDK will return an error. Otherwise the SDK tests the specified device and sets it as selected. The SDK will test the default device if no parameter is input.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
The function is disabled if no event handler is set.

◆ TestMicStopTesting()

virtual SDKError ITestAudioDeviceHelper::TestMicStopTesting ( )
pure virtual

Stop the mic test. The SDK will return an error if there is no mic test.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
The function is disabled if no event handler is set.

◆ TestSpeakerStartPlaying()

virtual SDKError ITestAudioDeviceHelper::TestSpeakerStartPlaying ( const wchar_t *  deviceID = NULL)
pure virtual

Start to test the speaker.

Parameters
deviceIDSpecify to test a speaker device. If the param is a wrong speaker ID, the SDK will return an error. Otherwise the SDK tests the specified device and sets it as selected. The SDK will test the default device if no parameter is input.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
The function is disabled if no event handler is set.

◆ TestSpeakerStopPlaying()

virtual SDKError ITestAudioDeviceHelper::TestSpeakerStopPlaying ( )
pure virtual

Stop the speaker test. The SDK will return an error if there is no speaker test.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
The function is disabled if no event handler is set.

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