Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingTestMicrophoneDeviceHelper Class Reference

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- startRecordingMic:
 This method is used to start recording when testing microphone.
 
(ZoomSDKError- stopRecrodingMic
 This method is used to stop recording when testing microphone.
 
(ZoomSDKError- playRecordedMic
 This method is used to play recorded sounds when testing microphone.
 
(ZoomSDKError- stopPlayRecordedMic
 This method is used to stop playing recorded sounds when testing microphone.
 
(ZoomSDKTestMicStatus- getTestMicStatus
 This method is used to get the status when testing microphone.
 

Protected Attributes

id< ZoomSDKSettingTestAudioDelegate_delegate
 
ZoomSDKTestMicStatus _testMicStatus
 
NSString * _microphoneID
 

Properties

id< ZoomSDKSettingTestAudioDelegatedelegate
 

Detailed Description

Definition at line 107 of file ZoomSDKSettingService.h.

Method Documentation

◆ getTestMicStatus

- (ZoomSDKTestMicStatus) getTestMicStatus

This method is used to get the status when testing microphone.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ playRecordedMic

- (ZoomSDKError) playRecordedMic

This method is used to play recorded sounds when testing microphone.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ startRecordingMic:

- (ZoomSDKError) startRecordingMic: (NSString *) deviceID

This method is used to start recording when testing microphone.

Parameters
deviceIDThe ID of the microphone device.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ stopPlayRecordedMic

- (ZoomSDKError) stopPlayRecordedMic

This method is used to stop playing recorded sounds when testing microphone.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ stopRecrodingMic

- (ZoomSDKError) stopRecrodingMic

This method is used to stop recording when testing microphone.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

Field Documentation

◆ _delegate

- (id<ZoomSDKSettingTestAudioDelegate>) _delegate
protected

Definition at line 109 of file ZoomSDKSettingService.h.

◆ _microphoneID

- (NSString*) _microphoneID
protected

Definition at line 111 of file ZoomSDKSettingService.h.

◆ _testMicStatus

- (ZoomSDKTestMicStatus) _testMicStatus
protected

Definition at line 110 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingTestAudioDelegate>) delegate
readwritenonatomicassign

Definition at line 113 of file ZoomSDKSettingService.h.