Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKVideoContainer.h
Go to the documentation of this file.
1
5
6
7#import <Foundation/Foundation.h>
8#import <ZoomSDK/ZoomSDKErrors.h>
9NS_ASSUME_NONNULL_BEGIN
10
12
18@interface ZoomSDKVideoElement : NSObject
19{
22 unsigned int _userid;
23 NSView* _videoView;
24 NSRect _viewFrame;
25}
29@property(nonatomic, assign)unsigned int userid;
33@property(nonatomic, retain, nullable)NSView* videoView;
38- (id)initWithFrame:(NSRect)rect;
44- (ZoomSDKError)showVideo:(BOOL)show;
59- (NSView*)getVideoView;
65- (ZoomSDKError)resize:(NSRect)frame;
66
72- (ZoomSDKError)setResolution:(ZoomSDKVideoRenderResolution)resolution;
73@end
74
75
86- (ZoomSDKError)startPreview:(BOOL)start;
87@end
88
89
100- (ZoomSDKError)startActiveView:(BOOL)start;
101@end
102
103
114- (ZoomSDKError)subscribeVideo:(BOOL)subscribe;
115@end
116
117
122@protocol ZoomSDKVideoContainerDelegate <NSObject>
128- (void)onRenderUserChanged:(ZoomSDKVideoElement*_Nullable)element User:(unsigned int)userid;
129
135- (void)onRenderDataTypeChanged:(ZoomSDKVideoElement*_Nullable)element DataType:(VideoRenderDataType)type;
136
142- (void)onSubscribeUserFail:(ZoomSDKVideoSubscribeFailReason)error videoElement:(ZoomSDKVideoElement*)element;
143@end
144
145
150@interface ZoomSDKVideoContainer : NSObject
151{
152 id<ZoomSDKVideoContainerDelegate> _delegate;
153 NSMutableArray* _elementArray;
154}
158@property(nonatomic,assign, nullable) id<ZoomSDKVideoContainerDelegate> delegate;
165- (ZoomSDKError)createVideoElement:(ZoomSDKVideoElement*_Nonnull*_Nonnull)element DEPRECATED_MSG_ATTRIBUTE("Use createPreViewVideoElement:, createNormalVideoElement:, or createActiveVideoElement: instead");
171- (ZoomSDKError)createPreViewVideoElement:(ZoomSDKPreViewVideoElement*_Nonnull*_Nonnull)element;
172
178- (ZoomSDKError)createNormalVideoElement:(ZoomSDKNormalVideoElement*_Nonnull*_Nonnull)element;
179
185- (ZoomSDKError)createActiveVideoElement:(ZoomSDKActiveVideoElement*_Nonnull*_Nonnull)element;
186
192- (ZoomSDKError)cleanVideoElement:(ZoomSDKVideoElement*)element;
193
198- (NSArray*_Nullable)getVideoElementList;
199@end
200NS_ASSUME_NONNULL_END
VideoRenderDataType
Enumeration of video render data types.
ZoomSDKVideoSubscribeFailReason
Enumeration of the type for video subscribe failed reason.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKVideoRenderResolution
Enumeration of video render resolution.
VideoRenderElementType
Enumeration of video render element types.
Subclass of ZoomSDKVideoElement for active speaker video.
Subclass of ZoomSDKVideoElement for normal participant video.
Subclass of ZoomSDKVideoElement for preview video.
Container class to manage multiple video elements.
NSArray *_Nullable getVideoElementList()
Gets the list of video element.
id< ZoomSDKVideoContainerDelegate > delegate
Delegate for video container callbacks.
id< ZoomSDKVideoContainerDelegate > _delegate
Interface for video element rendering in custom UI.
VideoRenderDataType _dataType
VideoRenderElementType _elementType
unsigned int userid
The user ID for this video element.
VideoRenderDataType getDataType()
Gets data type of video render: avatar or video.
VideoRenderElementType getElementType()
Gets the video's type render element: preview, active, or normal.
NSView * videoView
The view used to render video.
NSView * getVideoView()
Gets NSView object in the element.