Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKRawDataController.h
Go to the documentation of this file.
1
8
9
10#import <Foundation/Foundation.h>
11#import <ZoomSDK/ZoomSDKErrors.h>
12#import <ZoomSDK/ZoomSDKRenderer.h>
13
17
18NS_ASSUME_NONNULL_BEGIN
23typedef NS_ENUM(NSUInteger, ZoomSDKSessionSource) {
25 ZoomSDKSessionSource_CurrentSession = 0,
27 ZoomSDKSessionSource_MainSession = 1,
28};
29
34@interface ZoomSDKAudioRawData : NSObject
39- (BOOL)canAddRef;
44- (BOOL)addRef;
54- (char*_Nullable)getBuffer;
59- (unsigned int)getBufferLen;
64- (unsigned int)getSampleRate;
69- (unsigned int)getChannelNum;
74- (long long)getTimeStamp;
75@end
76
81@protocol ZoomSDKAudioRawDataDelegate <NSObject>
86- (void)onMixedAudioRawDataReceived:(ZoomSDKAudioRawData*_Nullable)data;
87
93- (void)onOneWayAudioRawDataReceived:(ZoomSDKAudioRawData*_Nullable)data userID:(unsigned int)userID;
94
100- (void)onShareAudioRawDataReceived:(ZoomSDKAudioRawData*_Nullable)data userID:(unsigned int)userID;
106- (void)onOneWayInterpreterAudioRawDataReceived:(ZoomSDKAudioRawData*)data strLanguageName:(NSString*)languageName;
107@end
108
109
114@interface ZoomSDKAudioRawDataHelper : NSObject
115{
116 id<ZoomSDKAudioRawDataDelegate> _delegate;
117}
122@property(nonatomic, assign, nullable)id<ZoomSDKAudioRawDataDelegate> delegate DEPRECATED_MSG_ATTRIBUTE("This property is deprecated. Use subscribe:delegate: to provide the delegate instead.");
127@property(nonatomic, assign)BOOL audioWithInterpreters;
133- (ZoomSDKError)subscribe DEPRECATED_MSG_ATTRIBUTE("This method is deprecated. Use subscribe:delegate: instead.");
139- (ZoomSDKError)subscribe:(ZoomSDKSessionSource)sources delegate:(id<ZoomSDKAudioRawDataDelegate>)delegate;
145- (ZoomSDKError)unSubscribe DEPRECATED_MSG_ATTRIBUTE("This method is deprecated. Use unSubscribe: instead.");
149- (ZoomSDKError)unSubscribe:(ZoomSDKSessionSource)sources;
150@end
151
156@interface ZoomSDKRawDataController : NSObject
157{
162}
173- (ZoomSDKError)getAudioRawDataHelper:(ZoomSDKAudioRawDataHelper*_Nullable* _Nonnull)audioRawDataHelper;
174
180- (ZoomSDKError)getRawDataVideoSourceHelper:(ZoomSDKRawDataVideoSourceController*_Nullable*_Nonnull)videoRawDataSendHelper;
181
187- (ZoomSDKError)getRawDataShareSourceHelper:(ZoomSDKRawDataShareSourceController*_Nullable*_Nonnull)shareRawDataSendHelper;
188
194- (ZoomSDKError)getRawDataAudioSourceHelper:(ZoomSDKRawDataAudioSourceController*_Nullable*_Nonnull)audioRawDataSendHelper;
195
201- (ZoomSDKError)createRender:(ZoomSDKRenderer*_Nullable*_Nonnull)render;
202
208- (ZoomSDKError)destroyRender:(ZoomSDKRenderer*_Nullable)render;
209@end
210NS_ASSUME_NONNULL_END
ZoomSDKError
Enumeration of common errors of SDK.
NS_ASSUME_NONNULL_BEGIN typedef NS_ENUM(NSUInteger, ZoomSDKSessionSource)
Enumeration of the meeting session a feature binds to.
Helper to subscribe or unsubscribe audio raw data.
id< ZoomSDKAudioRawDataDelegate > _delegate
ZoomSDKError subscribe()
Starts the audio raw data process.
BOOL audioWithInterpreters
If audioWithInterpreters is YES, it means that you want to get the audio data of interpreters....
ZoomSDKError unSubscribe()
Stops the audio raw data process for CurrentSession.
id< ZoomSDKAudioRawDataDelegate > delegate
Delegate for receiving audio raw data events.
Represents audio raw data received from the SDK.
int releaseData()
Release the object, if you has add ref, remeber to call this api to release when you wantn't to use t...
unsigned int getChannelNum()
Gets the channel number of this data.
char *_Nullable getBuffer()
Gets the buffer data.
BOOL canAddRef()
Gets if this object can add ref.
long long getTimeStamp()
Gets the raw's timestamp data.
unsigned int getSampleRate()
Gets the sample rate of this data.
BOOL addRef()
Adds reference for this object, if you doesn't add ref, this object is released when the callback res...
unsigned int getBufferLen()
Gets the buffer length of this data.
Configure external audio source as virtual microphone input.
Controller for managing raw data helpers and sources.
ZoomSDKAudioRawDataHelper * _audioRawDataHelper
ZoomSDKRawDataShareSourceController * _rawDataShareSourceHelper
ZoomSDKRawDataAudioSourceController * _rawDataAudioSourceHelper
ZoomSDKRawDataVideoSourceController * _rawDataVideoSourceHelper
ZoomSDKError hasRawDataLicense()
Query if the user has raw data license.
Manage external source for share video and share audio in meeting.
Controller for sending raw video frame data into the meeting.
Subscribe to raw video or share data and handle rendering.