Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
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< ZoomSDKSettingTestAudioDelegatedelegate
 Delegate to receive audio testing events.

Detailed Description

Helper class for testing microphone devices.

Definition at line 150 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.

References getTestMicStatus.

Referenced by getTestMicStatus.

◆ playRecordedMic

- (ZoomSDKError) playRecordedMic

Plays recorded sounds when testing microphone.

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

References playRecordedMic.

Referenced by playRecordedMic.

◆ startRecordingMic:

- (ZoomSDKError) startRecordingMic: (NSString *) deviceID

Starts recording when testing microphone.

Parameters
deviceIDThe 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.

References stopPlayRecordedMic.

Referenced by stopPlayRecordedMic.

◆ stopRecrodingMic

- (ZoomSDKError) stopRecrodingMic

Stops recording when testing microphone.

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

References stopRecrodingMic.

Referenced by stopRecrodingMic.

Field Documentation

◆ _delegate

- (id<ZoomSDKSettingTestAudioDelegate>) _delegate
protected

Definition at line 152 of file ZoomSDKSettingService.h.

◆ _microphoneID

- (NSString*) _microphoneID
protected

Definition at line 154 of file ZoomSDKSettingService.h.

◆ _testMicStatus

- (ZoomSDKTestMicStatus) _testMicStatus
protected

Definition at line 153 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingTestAudioDelegate>) delegate
readwritenonatomicassign

Delegate to receive audio testing events.

Definition at line 159 of file ZoomSDKSettingService.h.