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

Helper to subscribe or unsubscribe audio raw data. More...

#include <ZoomSDKRawDataController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError) - subscribe
 Starts the audio raw data process.
(ZoomSDKError) - subscribe:delegate:
 Subscribe audio raw data from one source.
(ZoomSDKError) - unSubscribe
 Stops the audio raw data process for CurrentSession.
(ZoomSDKError) - unSubscribe:
 Stop receiving raw audio data for one source.

Protected Attributes

id< ZoomSDKAudioRawDataDelegate > _delegate

Properties

id< ZoomSDKAudioRawDataDelegate > delegate
 Delegate for receiving audio raw data events.
BOOL audioWithInterpreters
 If audioWithInterpreters is YES, it means that you want to get the audio data of interpreters. Otherwise, NO.

Detailed Description

Helper to subscribe or unsubscribe audio raw data.

Definition at line 114 of file ZoomSDKRawDataController.h.

Method Documentation

◆ subscribe

- (ZoomSDKError) subscribe

Starts the audio raw data process.

Deprecated
Use subscribe:delegate: instead.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References subscribe.

Referenced by subscribe, and subscribe:delegate:.

◆ subscribe:delegate:

- (ZoomSDKError) subscribe: (ZoomSDKSessionSource) sources
delegate: (id< ZoomSDKAudioRawDataDelegate >) delegate 

Subscribe audio raw data from one source.

Parameters
sourcesCurrentSession or MainSession (webinar backstage only).
delegateCallback handler. Different source requires a different delegate.

References subscribe.

◆ unSubscribe

- (ZoomSDKError) unSubscribe

Stops the audio raw data process for CurrentSession.

Deprecated
Use unSubscribe: instead.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References unSubscribe.

Referenced by unSubscribe, and unSubscribe:.

◆ unSubscribe:

- (ZoomSDKError) unSubscribe: (ZoomSDKSessionSource) sources

Stop receiving raw audio data for one source.

References unSubscribe.

Field Documentation

◆ _delegate

- (id<ZoomSDKAudioRawDataDelegate>) _delegate
protected

Definition at line 116 of file ZoomSDKRawDataController.h.

Property Documentation

◆ audioWithInterpreters

- (BOOL) audioWithInterpreters
readwritenonatomicassign

If audioWithInterpreters is YES, it means that you want to get the audio data of interpreters. Otherwise, NO.

Note
if audioWithInterpreters is YES, it will cause your local interpreter related functions to be unavailable.

Definition at line 127 of file ZoomSDKRawDataController.h.

◆ delegate

- (id<ZoomSDKAudioRawDataDelegate>) delegate
readwritenonatomicassign

Delegate for receiving audio raw data events.

Deprecated
Use subscribe:delegate: to provide the delegate instead.

Definition at line 122 of file ZoomSDKRawDataController.h.