IZoomVideoSDKTestAudioDeviceHelper Class Reference

Audio setting interface. More...

#include <zoom_video_sdk_audio_setting_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	startMicTestRecording (const zchar_t *deviceID=nullptr)=0
	Start the mic test.
virtual ZoomVideoSDKErrors	stopMicTestRecording ()=0
	Stop the mic test. The SDK will return an error if there was no mic test.
virtual ZoomVideoSDKErrors	playMicTestRecording ()=0
	Play the mic recorded sound. If there was no mic test,the SDK returns an error.
virtual ZoomVideoSDKErrors	startSpeakerTest (const zchar_t *deviceID=nullptr)=0
	Start the speaker test.
virtual ZoomVideoSDKErrors	stopSpeakerTest ()=0
	Stop the speaker test. The SDK will return an error if there was no speaker test.
virtual ZoomVideoSDKErrors	setTimerInterval (unsigned int timerInterval)=0
	Set the time interval for the audio test.

Detailed Description

Audio setting interface.

Definition at line 45 of file zoom_video_sdk_audio_setting_interface.h.

Member Function Documentation

playMicTestRecording()

virtual ZoomVideoSDKErrors IZoomVideoSDKTestAudioDeviceHelper::playMicTestRecording ( )

pure virtual

Play the mic recorded sound. If there was no mic test,the SDK returns an error.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

Note

The function is disabled if no event handler is set.

setTimerInterval()

virtual ZoomVideoSDKErrors IZoomVideoSDKTestAudioDeviceHelper::setTimerInterval ( unsigned int timerInterval )

pure virtual

Set the time interval for the audio test.

Parameters

timerInterval

Usually the SDK sends the mic and speaker volumes every 200 ms by default via ITestAudioDeviceHelperEvent::onMicSpeakerVolumeChanged(). With this function, the user can modify the time interval instead of 200. Accepted values between 50 to 1000 milliseconds.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

Note

This interface will stop the mic or speaker test (if there is on ongoing). As a best practice, call it before the audio test.

startMicTestRecording()

virtual ZoomVideoSDKErrors IZoomVideoSDKTestAudioDeviceHelper::startMicTestRecording ( const zchar_t * deviceID = nullptr )

pure virtual

Start the mic test.

Parameters

deviceID

Specify 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 ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

Note

The function is disabled if no event handler is set.

startSpeakerTest()

virtual ZoomVideoSDKErrors IZoomVideoSDKTestAudioDeviceHelper::startSpeakerTest ( const zchar_t * deviceID = nullptr )

pure virtual

Start the speaker test.

Parameters

deviceID

Specify 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 ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

Note

The function is disabled if no event handler is set.

stopMicTestRecording()

virtual ZoomVideoSDKErrors IZoomVideoSDKTestAudioDeviceHelper::stopMicTestRecording ( )

pure virtual

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

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

Note

The function is disabled if no event handler is set.

stopSpeakerTest()

virtual ZoomVideoSDKErrors IZoomVideoSDKTestAudioDeviceHelper::stopSpeakerTest ( )

pure virtual

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

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

Note

The function is disabled if no event handler is set.