Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKRenderer.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8
9NS_ASSUME_NONNULL_BEGIN
12
17@interface ZoomSDKShareCursorData : NSObject
18
22@property (nonatomic, assign, readonly) unsigned int sourceID;
23
27@property (nonatomic, assign, readonly) int x;
28
32@property (nonatomic, assign, readonly) int y;
33@end
34
43@interface ZoomSDKFaceROI : NSObject
45@property (readonly, nonatomic) float left;
47@property (readonly, nonatomic) float top;
49@property (readonly, nonatomic) float right;
51@property (readonly, nonatomic) float bottom;
52@end
53
70@interface ZoomSDKFaceROIInfo : NSObject
71
83- (NSUInteger)getFaceCount;
84
94- (nullable ZoomSDKFaceROI *)getFaceROIByIndex:(NSUInteger)index;
95
96@end
97
102@interface ZoomSDKYUVRawDataI420 : NSObject
107- (BOOL)canAddRef;
112- (BOOL)addRef;
122- (char*_Nullable)getYBuffer;
127- (char*_Nullable)getUBuffer;
132- (char*_Nullable)getVBuffer;
137- (char*_Nullable)getBuffer;
142- (char*_Nullable)getAlphaBuffer;
147- (unsigned int)getBufferLen;
152- (unsigned int)getAlphaBufferLen;
162- (unsigned int)getStreamWidth;
167- (unsigned int)getStreamHeight;
172- (unsigned int)getRotation;
177- (unsigned int)getSourceID;
182- (long long)getTimeStamp;
183
196@end
197
198
203@protocol ZoomSDKRendererDelegate <NSObject>
212
217- (void)onRawDataReceived:(ZoomSDKYUVRawDataI420*_Nullable)data;
218@optional
223- (void)onShareCursorDataReceived:(ZoomSDKShareCursorData *)info;
224@required
229@end
230
231
236@interface ZoomSDKRenderer : NSObject
237{
238 unsigned int _subscribeID;
241 id<ZoomSDKRendererDelegate> _delegate;
242}
246@property(nonatomic, assign, nullable)id<ZoomSDKRendererDelegate> delegate;
247
254- (ZoomSDKError)subscribe:(unsigned int)subscribeID rawDataType:(ZoomSDKRawDataType)rawDataType;
255
261
267
272- (unsigned int)getSubscribeID;
273
279
285- (ZoomSDKError)setResolution:(ZoomSDKResolution)resolution;
286@end
287
288NS_ASSUME_NONNULL_END
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKResolution
Enumeration of video resolution options.
ZoomSDKRawDataType
Enumeration of raw data types.
Face region of interest reported alongside a decoded frame.
Per-frame face ROI metadata accessor.
NSUInteger getFaceCount()
Number of valid face ROIs available for the current frame.
Subscribe to raw video or share data and handle rendering.
ZoomSDKResolution getResolution()
Gets the resolution of raw data.
unsigned int getSubscribeID()
Gets the subscribe ID of raw data user is subscribing to.
unsigned int _subscribeID
ZoomSDKRawDataType _rawDataType
id< ZoomSDKRendererDelegate > _delegate
ZoomSDKError unSubscribe()
Unsubscribe to receive raw data.
ZoomSDKRawDataType getRawDataType()
Gets the type of raw data.
id< ZoomSDKRendererDelegate > delegate
The delegate to receive rendering events.
ZoomSDKResolution _resolution
Represents the cursor position data during screen sharing.
int x
The x value of the coordinate.
int y
The y value of the coordinate.
unsigned int sourceID
The source ID of the share cursor.
Represents raw YUV I420 format data received from subscribed video stream.
char *_Nullable getBuffer()
Gets the buffer data.
unsigned int getStreamHeight()
Gets the stream height of this data.
int releaseData()
Release the object, if you has add ref, remeber to call this api to release when you wantn't to use t...
BOOL addRef()
Adds reference for this object, if you doesn't add ref, this object is released when the callback res...
BOOL canAddRef()
Gets if this object can add ref.
unsigned int getAlphaBufferLen()
Gets the alpha buffer length.
char *_Nullable getAlphaBuffer()
Gets video alpha mask data buffer.
unsigned int getSourceID()
Gets the s␝ource ID of this data.
unsigned int getStreamWidth()
Gets the stream width of this data.
unsigned int getRotation()
Gets the rotation of this data.
char *_Nullable getUBuffer()
Gets the U data.
char *_Nullable getYBuffer()
Gets the Y data.
unsigned int getBufferLen()
Gets the buffer length of this data.
BOOL isLimitedI420()
Gets if this data is limited I420 format.
ZoomSDKFaceROIInfo * getFaceROIInfo()
Gets the face ROI metadata associated with this frame.
long long getTimeStamp()
Gets the raw data's timestamp.
char *_Nullable getVBuffer()
Gets the V data.
void onRendererBeDestroyed()
Notify if the renderer is being destroyed.
void onSubscribedUserDataOff()
Notify if subscribed user's video data becomes unavailable.
void onSubscribedUserDataOn()
Notify if subscribed user's video data becomes available.