Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
Instance Methods | Protected Attributes | Properties
ZoomSDKSettingTestSpeakerDeviceHelper Class Reference

Helper class to test speaker devices. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError) - SpeakerStartPlaying:
 This method is used to start playing when testing speaker.
 
(ZoomSDKError) - SpeakerStopPlaying
 This method is used to stop 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 115 of file ZoomSDKSettingService.h.

Method Documentation

◆ SpeakerStartPlaying:

- (ZoomSDKError) SpeakerStartPlaying: (NSString *) deviceID

This method is used to start playing when testing speaker.

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

◆ SpeakerStopPlaying

- (ZoomSDKError) SpeakerStopPlaying

This method is used to stop playing when testing speaker.

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

Field Documentation

◆ _delegate

- (id<ZoomSDKSettingTestAudioDelegate>) _delegate
protected

Definition at line 117 of file ZoomSDKSettingService.h.

◆ _isSpeakerInTesting

- (BOOL) _isSpeakerInTesting
protected

Definition at line 118 of file ZoomSDKSettingService.h.

◆ _speakerID

- (NSString*) _speakerID
protected

Definition at line 119 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingTestAudioDelegate>) delegate
readwritenonatomicassign

Delegate to receive audio testing events.

Definition at line 129 of file ZoomSDKSettingService.h.

◆ isSpeakerInTesting

- (BOOL) isSpeakerInTesting
readwritenonatomicassign

Indicates whether speaker testing is in progress.

Definition at line 124 of file ZoomSDKSettingService.h.