ZoomSDKASController.h

Go to the documentation of this file.

 
 
#import <ZoomSDK/ZoomSDKErrors.h>
#import <ZoomSDK/ZoomSDKCustomizedAnnotationCtr.h>
#import <ZoomSDK/ZoomSDKShareContainer.h>
#import <ZoomSDK/ZoomSDKRemoteControllerHelper.h>
 
NS_ASSUME_NONNULL_BEGIN
@interface ZoomSDKAnnotationController :NSObject
 
- (BOOL)isAnnotationDisable;
 
- (ZoomSDKError)setTool:(AnnotationToolType)type onScreen:(ScreenType)screen;
 
- (ZoomSDKError)clear:(AnnotationClearType)type onScreen:(ScreenType)screen;
 
- (ZoomSDKError)setColor:(float)red Green:(float)green Black:(float)black onScreen:(ScreenType)screen;
 
- (ZoomSDKError)setLineWidth:(long)lineWidth onScreen:(ScreenType)screen;
 
- (ZoomSDKError)undo:(ScreenType)screen;
 
- (ZoomSDKError)redo:(ScreenType)screen;
 
- (BOOL)isAnnotationLegalNoticeAvailable;
 
- (NSString *)getAnnotationLegalNoticesPrompt;
 
- (NSString *)getAnnotationLegalNoticesExplained;
@end
 
 
@interface ZoomSDKSharingSourceInfo: NSObject
@property(nonatomic, assign, readonly) unsigned int              shareSourceID;
@property(nonatomic, assign, readonly) unsigned int              userID;
@property(nonatomic, assign, readonly) ZoomSDKShareContentType   contentType;
@property(nonatomic, assign, readonly) ZoomSDKShareStatus        status;
@property(nonatomic, assign, readonly) CGWindowID                windowID;
@property(nonatomic, assign, readonly) CGDirectDisplayID         displayID;
@property(nonatomic, assign, readonly) BOOL                      isShowInFirstScreen; //Available only for Zoom UI mode.
@property(nonatomic, assign, readonly) BOOL                      isShowInSecondScreen; //Available only for Zoom UI mode.
@property(nonatomic, assign, readonly) BOOL                      canBeRemoteControl;
@property(nonatomic, assign, readonly) BOOL                      bEnableOptimizingVideoSharing; //Determine if optimizing video sharing is enabled.
 
- (ZoomSDKError)getWindowID:(CGWindowID*)windowID;
 
- (ZoomSDKError)getDisplayID:(CGDirectDisplayID*)displayID;
@end
 
 
@interface ZoomSDKSplitScreenInfo : NSObject
{
    BOOL _isInSplitScreenMode;
    BOOL _isSupportSplitScreenMode;
}
 
- (BOOL)isInSplitScreenMode;
- (BOOL)isSupportSplitScreenMode;
@end
 
@protocol ZoomSDKASControllerDelegate <NSObject>
@optional
- (void)onSharingStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
 
- (void)onFailedToStartShare;
 
- (void)onShareStatusLocked:(BOOL)shareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (void)onShareContentChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
 
- (void)onAnnotationSupportPropertyChanged:(BOOL)isSupportAnnotation shareSourceID:(unsigned int)shareSourceID;
 
- (void)onShareSettingTypeChanged:(ZoomSDKShareSettingType)type;
 
- (void)onSharedVideoEnded;
 
- (void)onVideoFileSharePlayError:(ZoomSDKVideoFileSharePlayError)error;
 
- (void)onOptimizingShareForVideoClipStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
@end
 
 
@interface ZoomSDKASController : NSObject
{
    id<ZoomSDKASControllerDelegate> _delegate;
    ZoomSDKShareContainer* _shareContainer;
    ZoomSDKAnnotationController* _annotationController;
    ZoomSDKCustomizedAnnotationCtr* _customizedAnnotationCtr;
    ZoomSDKRemoteControllerHelper*  _remoteControllerHelper;
}
@property(nonatomic, assign, nullable)id<ZoomSDKASControllerDelegate> delegate;
@property(nonatomic, assign, readwrite) BOOL enableShareComputerSound;
@property(nonatomic, assign, readwrite) BOOL enableOptimizingScreenShareForVideoClip;
 
- (ZoomSDKError)startAppShare:(CGWindowID)windowID;
 
- (BOOL)isShareAppValid:(CGWindowID)windowID;
 
- (ZoomSDKError)startMonitorShare:(CGDirectDisplayID)monitorID;
 
- (ZoomSDKError)stopShare;
 
- (NSArray<NSNumber *>* _Nullable)getViewableSharingUserList;
 
- (NSArray<ZoomSDKSharingSourceInfo *>* _Nullable)getSharingSourceInfoList:(unsigned int)userID;
 
- (ZoomSDKError)viewShare:(unsigned int)shareSourceID onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (BOOL)canStartShare DEPRECATED_MSG_ATTRIBUTE("Use -canStartShare: instead");
 
- (BOOL)canStartShare:(ZoomSDKCannotShareReasonType*)reason;
 
- (BOOL)isShareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (BOOL)isDesktopSharingEnabled;
 
- (ZoomSDKAnnotationController*_Nullable)getAnnotationController;
 
- (ZoomSDKCustomizedAnnotationCtr*_Nullable)getCustomizedAnnotationCtr;
 
- (ZoomSDKShareContainer*_Nullable)getShareContainer;
 
- (ZoomSDKRemoteControllerHelper*_Nullable)getRemoteControllerHelper;
 
- (ZoomSDKError)startAnnotation:(NSPoint)position onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("Use -startAnnotation: instead");
 
- (ZoomSDKError)startAnnotation:(ScreenType)screen;
 
- (ZoomSDKError)stopAnnotation:(ScreenType)screen;
 
- (ZoomSDKError)getCurrentRemoteController:(unsigned int*)userID DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (ZoomSDKSplitScreenInfo*_Nullable)getCurrentSplitScreenModeInfo;
 
- (ZoomSDKError)switchSplitScreenMode:(BOOL)switchTo;
 
- (void)cleanUp;
 
- (ZoomSDKError)startWhiteBoardShare;
 
- (ZoomSDKError)startFrameShare;
 
- (ZoomSDKError)startAudioShare;
 
- (ZoomSDKError)startShareCamera:(NSString*)deviceID displayWindow:(NSWindow*)window;
 
- (ZoomSDKError)startShareCamera;
 
- (BOOL)canSwitchToShareNextCamera;
- (ZoomSDKError)switchToShareNextCamera;
 
- (ZoomSDKError)startVideoFileShare:(NSString*)filePath;
 
- (ZoomSDKError)startVideoFileShare:(NSString*)filePath displayWindow:(NSWindow*)window;
 
- (BOOL)isAbleToShareWhiteBoard;
- (BOOL)isAbleToShareFrame;
- (BOOL)isAbleToShareComputerAudio;
- (BOOL)isAbleToShareCamera;
 
- (BOOL)canShareVideoFile;
 
- (BOOL)canEnableShareToBO;
 
- (BOOL)isShareToBOEnabled;
 
- (ZoomSDKError)enableShareToBO:(BOOL)bEnable;
 
- (ZoomSDKError)disableViewerAnnotation:(ScreenType)screenType disable:(BOOL)disable;
 
- (ZoomSDKError)isViewerAnnotationLocked:(ScreenType)screenType isLocked:(BOOL*)locked;
 
- (ZoomSDKError)canDisableViewerAnnotation:(ScreenType)screenType canDisabled:(BOOL*)canDisable;
 
- (ZoomSDKError)canDoAnnotation:(ScreenType)screenType canAnnotate:(BOOL*)canAnnotate;
 
- (BOOL)isSupportEnableOptimizeForFullScreenVideoClip;
 
- (BOOL)isEnableShareComputerSoundOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableShareComputerSoundOnWhenSharing instead");
 
- (BOOL)isEnableShareComputerSoundOnWhenSharing;
 
- (BOOL)isEnableOptimizeForFullScreenVideoClipOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableOptimizeForFullScreenVideoClipOnWhenSharing instead");
 
- (BOOL)isEnableOptimizeForFullScreenVideoClipOnWhenSharing;
 
- (BOOL)isSupportShareWithComputerSound:(ZoomSDKShareContentType)type;
 
- (BOOL)isCurrentSharingSupportShareWithComputerSound;
 
- (ZoomSDKError)enableShareComputerSound:(BOOL)enable;
 
- (ZoomSDKError)enableOptimizingScreenShareForVideoClip:(BOOL)enable;
 
- (ZoomSDKError)setAudioShareMode:(ZoomSDKAudioShareMode)mode;
 
- (ZoomSDKError)getAudioShareMode:(ZoomSDKAudioShareMode*)mode;
 
- (ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
 
- (ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
 
- (BOOL)isWhiteboardLegalNoticeAvailable;
 
- (NSString *)getWhiteboardLegalNoticesPrompt;
 
- (NSString *)getWhiteboardLegalNoticesExplained;
 
- (ZoomSDKError)switchZoomRatioWhenViewShare:(unsigned int)shareSourceID zoomRatio:(ZoomSDKShareViewZoomRatio)zoomRatio;
 
- (ZoomSDKError)enableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID enable:(BOOL)enable;
 
- (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID bCan:(BOOL*)bCan;
@end
NS_ASSUME_NONNULL_END