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
21@interface ZoomSDKFaceROI : NSObject
23@property (readonly, nonatomic) float left;
25@property (readonly, nonatomic) float top;
27@property (readonly, nonatomic) float right;
29@property (readonly, nonatomic) float bottom;
30@end
31
48@interface ZoomSDKFaceROIInfo : NSObject
49
61- (NSUInteger)getFaceCount;
62
72- (nullable ZoomSDKFaceROI *)getFaceROIByIndex:(NSUInteger)index;
73
74@end
75
80@interface ZoomSDKYUVRawDataI420 : NSObject
85- (BOOL)canAddRef;
90- (BOOL)addRef;
100- (char*_Nullable)getYBuffer;
105- (char*_Nullable)getUBuffer;
110- (char*_Nullable)getVBuffer;
115- (char*_Nullable)getBuffer;
120- (char*_Nullable)getAlphaBuffer;
125- (unsigned int)getBufferLen;
130- (unsigned int)getAlphaBufferLen;
140- (unsigned int)getStreamWidth;
145- (unsigned int)getStreamHeight;
150- (unsigned int)getRotation;
155- (unsigned int)getSourceID;
160- (long long)getTimeStamp;
161
174@end
175
176
181@protocol ZoomSDKRendererDelegate <NSObject>
194- (void)onSubscribedUserLeft DEPRECATED_MSG_ATTRIBUTE("No longer used");
199- (void)onRawDataReceived:(ZoomSDKYUVRawDataI420*_Nullable)data;
204@end
205
206
211@interface ZoomSDKRenderer : NSObject
212{
213 unsigned int _subscribeID;
216 id<ZoomSDKRendererDelegate> _delegate;
217}
221@property(nonatomic, assign, nullable)id<ZoomSDKRendererDelegate> delegate;
222
229- (ZoomSDKError)subscribe:(unsigned int)subscribeID rawDataType:(ZoomSDKRawDataType)rawDataType;
230
236
242
247- (unsigned int)getSubscribeID;
248
254
260- (ZoomSDKError)setResolution:(ZoomSDKResolution)resolution;
261@end
262
263NS_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 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.
void onSubscribedUserLeft()
Notify if subscribed user has left.