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

Helper class to test speaker devices. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError) - SpeakerStartPlaying:
 Starts playing when testing speaker.
(ZoomSDKError) - SpeakerStopPlaying
 Stops playing when testing speaker.

Protected Attributes

id< ZoomSDKSettingTestAudioDelegate > _delegate
BOOL _isSpeakerInTesting
NSString * _speakerID

Properties

BOOL isSpeakerInTesting
 Indicates whether speaker testing is in progress.
id< ZoomSDKSettingTestAudioDelegate > delegate
 Delegate to receive audio testing events.

Detailed Description

Helper class to test speaker devices.

Definition at line 116 of file ZoomSDKSettingService.h.

Method Documentation

◆ SpeakerStartPlaying:

- (ZoomSDKError) SpeakerStartPlaying: (NSString *) deviceID

Starts playing when testing speaker.

Parameters
deviceIDThe speaker's device ID.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ SpeakerStopPlaying

- (ZoomSDKError) SpeakerStopPlaying

Stops playing when testing speaker.

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

References SpeakerStopPlaying.

Referenced by SpeakerStopPlaying.

Field Documentation

◆ _delegate

- (id<ZoomSDKSettingTestAudioDelegate>) _delegate
protected

Definition at line 118 of file ZoomSDKSettingService.h.

◆ _isSpeakerInTesting

- (BOOL) _isSpeakerInTesting
protected

Definition at line 119 of file ZoomSDKSettingService.h.

◆ _speakerID

- (NSString*) _speakerID
protected

Definition at line 120 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingTestAudioDelegate>) delegate
readwritenonatomicassign

Delegate to receive audio testing events.

Definition at line 130 of file ZoomSDKSettingService.h.

◆ isSpeakerInTesting

- (BOOL) isSpeakerInTesting
readwritenonatomicassign

Indicates whether speaker testing is in progress.

Definition at line 125 of file ZoomSDKSettingService.h.