ZoomSDKSettingTestMicrophoneDeviceHelper Class Reference

Helper class for testing microphone devices. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- startRecordingMic:
	Starts recording when testing microphone.
(ZoomSDKError)	- stopRecrodingMic
	Stops recording when testing microphone.
(ZoomSDKError)	- playRecordedMic
	Plays recorded sounds when testing microphone.
(ZoomSDKError)	- stopPlayRecordedMic
	Stops playing recorded sounds when testing microphone.
(ZoomSDKTestMicStatus)	- getTestMicStatus
	Gets the status when testing microphone.

Protected Attributes
id< ZoomSDKSettingTestAudioDelegate >	_delegate
ZoomSDKTestMicStatus	_testMicStatus
NSString *	_microphoneID

Properties
id< ZoomSDKSettingTestAudioDelegate >	delegate
	Delegate to receive audio testing events.

Detailed Description

Helper class for testing microphone devices.

Definition at line 149 of file ZoomSDKSettingService.h.

Method Documentation

getTestMicStatus

- (ZoomSDKTestMicStatus) getTestMicStatus

Gets the status when testing microphone.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

playRecordedMic

- (ZoomSDKError) playRecordedMic

Plays recorded sounds when testing microphone.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

startRecordingMic:

- (ZoomSDKError) startRecordingMic:

(NSString *)

deviceID

Starts recording when testing microphone.

Parameters

deviceID

The microphone's device ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

stopPlayRecordedMic

- (ZoomSDKError) stopPlayRecordedMic

Stops playing recorded sounds when testing microphone.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

stopRecrodingMic

- (ZoomSDKError) stopRecrodingMic

Stops recording when testing microphone.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

_delegate

- (id<ZoomSDKSettingTestAudioDelegate>) _delegate

protected

Definition at line 151 of file ZoomSDKSettingService.h.

_microphoneID

- (NSString*) _microphoneID

protected

Definition at line 153 of file ZoomSDKSettingService.h.

_testMicStatus

- (ZoomSDKTestMicStatus) _testMicStatus

protected

Definition at line 152 of file ZoomSDKSettingService.h.

Property Documentation

delegate

- (id<ZoomSDKSettingTestAudioDelegate>) delegate

readwritenonatomicassign

Delegate to receive audio testing events.

Definition at line 158 of file ZoomSDKSettingService.h.