ZoomSDKCustomImmersiveController.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import "ZoomSDKErrors.h"
 
NS_ASSUME_NONNULL_BEGIN
@interface ZoomSDKCustomImmersiveContainer : NSObject
@property(nonatomic, assign, readonly) NSView* containerView;
 
- (ZoomSDKError)repositionContainer:(NSRect)rect;
 
- (ZoomSDKError)showWaitingArea;
 
- (ZoomSDKError)hideWaitingArea;
@end
 
typedef enum
{
    ZoomSDKCustomImmersiveTemplateType_Default, //The default template.
    ZoomSDKCustomImmersiveTemplateType_CustomImage, //A template using a custom image.
    ZoomSDKCustomImmersiveTemplateType_MyVideo   //The my video template.
}ZoomSDKCustomImmersiveTemplateType;
 
 
@interface ZoomSDKSeatPlacementInfo : NSObject
@property(nonatomic, copy, readonly, nullable) NSString* seatID;
@property(nonatomic, assign, readonly) NSRect position;
@end
 
 
@interface ZoomSDKCustomImmersiveLayoutData : NSObject
@property(nonatomic,assign) BOOL isSeatFree;
@property(nonatomic,copy, nullable) NSString* seatID;
@property(nonatomic,assign) unsigned int userID;
@property(nonatomic,assign, readonly) unsigned int zOrder;
@property(nonatomic,assign) NSRect position;
@end
 
 
@interface ZoomSDKCustomImmersiveTemplateData : NSObject
@property(nonatomic,retain, readonly, nullable) NSArray<ZoomSDKSeatPlacementInfo*>* seatList;
@property(nonatomic,assign, readonly) NSSize canvasSize;
@end
 
 
@interface ZoomSDKCustomImmersiveTemplate : NSObject
@property(nonatomic,copy, readonly, nullable) NSString* templateName;
@property(nonatomic,retain, readonly, nullable) NSBitmapImageRep* thumbnailBitmap;
@property(nonatomic,assign, readonly) unsigned int capacity;
@property(nonatomic,assign, readonly) BOOL isTemplateReady;
@property(nonatomic,assign, readonly) BOOL isSupportFreeSeat;
@property(nonatomic,assign, readonly) ZoomSDKCustomImmersiveTemplateType templateType;
@property(nonatomic,retain, readonly, nullable) ZoomSDKCustomImmersiveTemplateData* shareTemplateData;
 
@property(nonatomic,retain, readonly, nullable) ZoomSDKCustomImmersiveTemplateData* videoTemplateData;
@end
 
 
@protocol ZoomSDKCustomImmersiveDelegate <NSObject>
- (void)onImmersiveStatusChanged:(BOOL)isOn;
 
- (void)onSelectedImmersiveTemplateChanged:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate;
 
- (void)onImmersiveSeatLayoutUpdated:(NSArray<ZoomSDKCustomImmersiveLayoutData*>*)data;
 
- (void)onTemplateDownloadProgress:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate progress:(unsigned int)progress;
 
- (void)onTemplateDownloadEnded:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate bSuccess:(BOOL)bSuccess;
 
- (void)onTemplateThumbnailsDownloadEnded:(BOOL)bSuccess;
 
- (void)onImmersiveContainerDestroyed;
@end
 
 
@interface ZoomSDKCustomImmersiveController : NSObject
@property(nonatomic, assign, nullable) id<ZoomSDKCustomImmersiveDelegate> delegate;
 
- (BOOL)isImmersiveViewOn;
 
- (ZoomSDKError)isInImmersiveShareMode:(BOOL*)bInShare;
 
- (ZoomSDKError)viewShare:(unsigned int)shareSourceID;
 
- (ZoomSDKError)getViewingShareSourceID:(unsigned int*)shareSourceID;
 
- (BOOL)isSupportImmersive;
 
- (BOOL)isTemplateThumbnailsReady;
 
- (BOOL)canStartImmersiveView:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate;
 
- (ZoomSDKError)startImmersiveView:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate;
 
- (ZoomSDKError)changeTemplate:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate;
 
- (ZoomSDKError)endImmersiveView;
 
- (BOOL)canUserShowInImmersiveView:(unsigned int)userID;
 
- (NSArray<ZoomSDKCustomImmersiveLayoutData*>*_Nullable)getLayoutData;
 
- (ZoomSDKError)updateLayoutData:(NSArray<ZoomSDKCustomImmersiveLayoutData*>*)dataArray;
 
- (ZoomSDKError)assignUser:(unsigned int)userID seatID:(NSString*)seatID;
 
- (ZoomSDKError)putUserToFreeSeat:(unsigned int)userID pos:(NSRect)pos;
 
- (ZoomSDKError)removeUser:(unsigned int)userID;
 
- (BOOL)isUserInImmersiveView:(unsigned int)userID;
 
- (ZoomSDKError)downloadTemplateThumbnails;
 
- (ZoomSDKError)downloadTemplate:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate;
 
- (ZoomSDKError)addCustomImageTemplate:(NSString*)filePath template:(ZoomSDKCustomImmersiveTemplate*_Nullable*_Nonnull)immersiveTemplate;
 
- (ZoomSDKError)removeCustomImageTemplate:(ZoomSDKCustomImmersiveTemplate*)immersiveTemplate;
 
- (ZoomSDKCustomImmersiveTemplate*_Nullable)getCurrentTemplate;
 
- (NSArray<ZoomSDKCustomImmersiveTemplate*>*_Nullable)getTemplates;
 
- (ZoomSDKCustomImmersiveContainer*_Nullable)createImmersiveContainer:(NSRect)rect;
 
- (ZoomSDKError)destroyImmersiveContainer;
@end
NS_ASSUME_NONNULL_END