Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKASController.h
Go to the documentation of this file.
1
6#import <ZoomSDK/ZoomSDKErrors.h>
7#import <ZoomSDK/ZoomSDKCustomizedAnnotationCtr.h>
8#import <ZoomSDK/ZoomSDKShareContainer.h>
9#import <ZoomSDK/ZoomSDKRemoteControllerHelper.h>
10
11NS_ASSUME_NONNULL_BEGIN
17@interface ZoomSDKAnnotationController :NSObject
18
24
32- (ZoomSDKError)setTool:(AnnotationToolType)type onScreen:(ScreenType)screen;
33
40- (ZoomSDKError)clear:(AnnotationClearType)type onScreen:(ScreenType)screen;
41
51- (ZoomSDKError)setColor:(float)red Green:(float)green Black:(float)black onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("Use -setColor:green:blue:onScreen: instead");
52
61- (ZoomSDKError)setColor:(float)red green:(float)green blue:(float)blue onScreen:(ScreenType)screen;
62
69- (ZoomSDKError)setLineWidth:(long)lineWidth onScreen:(ScreenType)screen;
70
76- (ZoomSDKError)undo:(ScreenType)screen;
77
83- (ZoomSDKError)redo:(ScreenType)screen;
84
90
96
102@end
103
104
109@interface ZoomSDKSharingSourceInfo: NSObject
113@property(nonatomic, assign, readonly) unsigned int shareSourceID;
117@property(nonatomic, assign, readonly) unsigned int userID;
121@property(nonatomic, assign, readonly) ZoomSDKShareContentType contentType;
125@property(nonatomic, assign, readonly) ZoomSDKShareStatus status;
129@property(nonatomic, assign, readonly) CGWindowID windowID;
133@property(nonatomic, assign, readonly) CGDirectDisplayID displayID;
137@property(nonatomic, assign, readonly) BOOL isShowInFirstScreen;
141@property(nonatomic, assign, readonly) BOOL isShowInSecondScreen;
145@property(nonatomic, assign, readonly) BOOL canBeRemoteControl;
149@property(nonatomic, assign, readonly) BOOL bEnableOptimizingVideoSharing;
150
155- (ZoomSDKError)getWindowID:(CGWindowID*)windowID;
156
161- (ZoomSDKError)getDisplayID:(CGDirectDisplayID*)displayID;
162@end
163
164
169@interface ZoomSDKSplitScreenInfo : NSObject
170{
173}
178- (BOOL)isInSplitScreenMode;
179
184- (BOOL)isSupportSplitScreenMode;
185@end
186
191@protocol ZoomSDKASControllerDelegate <NSObject>
192@optional
197- (void)onSharingStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
198
202- (void)onFailedToStartShare;
203
209- (void)onShareStatusLocked:(BOOL)shareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
210
215- (void)onShareContentChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
216
222- (void)onAnnotationSupportPropertyChanged:(BOOL)isSupportAnnotation shareSourceID:(unsigned int)shareSourceID;
223
228- (void)onShareSettingTypeChanged:(ZoomSDKShareSettingType)type;
229
233- (void)onSharedVideoEnded;
234
239- (void)onVideoFileSharePlayError:(ZoomSDKVideoFileSharePlayError)error;
240
245- (void)onOptimizingShareForVideoClipStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
246@end
247
248
249
254@interface ZoomSDKASController : NSObject
255{
256 id<ZoomSDKASControllerDelegate> _delegate;
261}
265@property(nonatomic, assign, nullable)id<ZoomSDKASControllerDelegate> delegate;
269@property(nonatomic, assign, readwrite) BOOL enableShareComputerSound;
273@property(nonatomic, assign, readwrite) BOOL enableOptimizingScreenShareForVideoClip;
274
280- (ZoomSDKError)startAppShare:(CGWindowID)windowID;
281
286- (BOOL)isShareAppValid:(CGWindowID)windowID;
287
293- (ZoomSDKError)startMonitorShare:(CGDirectDisplayID)monitorID;
294
299- (ZoomSDKError)stopShare;
300
305- (NSArray<NSNumber *>* _Nullable)getViewableSharingUserList;
306
312- (NSArray<ZoomSDKSharingSourceInfo *>* _Nullable)getSharingSourceInfoList:(unsigned int)userID;
313
321- (ZoomSDKError)viewShare:(unsigned int)shareSourceID onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("No longer used");
322
328- (BOOL)canStartShare DEPRECATED_MSG_ATTRIBUTE("Use -canStartShare: instead");
329
335- (BOOL)canStartShare:(ZoomSDKCannotShareReasonType*)reason;
336
342- (BOOL)isShareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
343
348- (BOOL)isDesktopSharingEnabled;
349
354- (ZoomSDKAnnotationController*_Nullable)getAnnotationController;
355
360- (ZoomSDKCustomizedAnnotationCtr*_Nullable)getCustomizedAnnotationCtr;
361
366- (ZoomSDKShareContainer*_Nullable)getShareContainer;
367
372- (ZoomSDKRemoteControllerHelper*_Nullable)getRemoteControllerHelper;
373
381- (ZoomSDKError)startAnnotation:(NSPoint)position onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("Use -startAnnotation: instead");
382
388- (ZoomSDKError)startAnnotation:(ScreenType)screen;
389
395- (ZoomSDKError)stopAnnotation:(ScreenType)screen;
396
403- (ZoomSDKError)getCurrentRemoteController:(unsigned int*)userID DEPRECATED_MSG_ATTRIBUTE("No longer used");
404
409- (ZoomSDKSplitScreenInfo*_Nullable)getCurrentSplitScreenModeInfo;
410
416- (ZoomSDKError)switchSplitScreenMode:(BOOL)switchTo;
417
421- (void)cleanUp;
422
427- (ZoomSDKError)startWhiteBoardShare;
428
433- (ZoomSDKError)startFrameShare;
434
439- (ZoomSDKError)startAudioShare;
440
447- (ZoomSDKError)startShareCamera:(NSString*)deviceID displayWindow:(NSWindow*)window;
448
453- (ZoomSDKError)startShareCamera;
454
459- (BOOL)canSwitchToShareNextCamera;
464- (ZoomSDKError)switchToShareNextCamera;
465
471- (ZoomSDKError)startVideoFileShare:(NSString*)filePath;
472
479- (ZoomSDKError)startVideoFileShare:(NSString*)filePath displayWindow:(NSWindow*)window;
480
485- (BOOL)isAbleToShareWhiteBoard;
490- (BOOL)isAbleToShareFrame;
495- (BOOL)isAbleToShareComputerAudio;
500- (BOOL)isAbleToShareCamera;
501
506- (BOOL)canShareVideoFile;
507
513- (BOOL)canEnableShareToBO;
514
520- (BOOL)isShareToBOEnabled;
521
528- (ZoomSDKError)enableShareToBO:(BOOL)bEnable;
529
536- (ZoomSDKError)disableViewerAnnotation:(ScreenType)screenType disable:(BOOL)disable;
537
544- (ZoomSDKError)isViewerAnnotationLocked:(ScreenType)screenType isLocked:(BOOL*)locked;
545
552- (ZoomSDKError)canDisableViewerAnnotation:(ScreenType)screenType canDisabled:(BOOL*)canDisable;
553
560- (ZoomSDKError)canDoAnnotation:(ScreenType)screenType canAnnotate:(BOOL*)canAnnotate;
561
566- (BOOL)isSupportEnableOptimizeForFullScreenVideoClip;
567
573- (BOOL)isEnableShareComputerSoundOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableShareComputerSoundOnWhenSharing instead");
574
579- (BOOL)isEnableShareComputerSoundOnWhenSharing;
580
586- (BOOL)isEnableOptimizeForFullScreenVideoClipOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableOptimizeForFullScreenVideoClipOnWhenSharing instead");
587
592- (BOOL)isEnableOptimizeForFullScreenVideoClipOnWhenSharing;
593
599- (BOOL)isSupportShareWithComputerSound:(ZoomSDKShareContentType)type;
600
605- (BOOL)isCurrentSharingSupportShareWithComputerSound;
606
612- (ZoomSDKError)enableShareComputerSound:(BOOL)enable;
613
619- (ZoomSDKError)enableOptimizingScreenShareForVideoClip:(BOOL)enable;
620
626- (ZoomSDKError)setAudioShareMode:(ZoomSDKAudioShareMode)mode;
627
633- (ZoomSDKError)getAudioShareMode:(ZoomSDKAudioShareMode*)mode;
634
640- (ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
641
647- (ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
648
653- (BOOL)isWhiteboardLegalNoticeAvailable;
654
659- (NSString *)getWhiteboardLegalNoticesPrompt;
660
665- (NSString *)getWhiteboardLegalNoticesExplained;
666
673- (ZoomSDKError)switchZoomRatioWhenViewShare:(unsigned int)shareSourceID zoomRatio:(ZoomSDKShareViewZoomRatio)zoomRatio;
674
681- (ZoomSDKError)enableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID enable:(BOOL)enable;
682
689- (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID bCan:(BOOL*)bCan;
690@end
691NS_ASSUME_NONNULL_END
692
AnnotationToolType
Type of annotation tools. For more information, please visit https://support.zoom....
ZoomSDKShareStatus
Enumeration of sharing status.
AnnotationClearType
Types of clearing annotations.
ZoomSDKShareViewZoomRatio
Enumeration of zoom ratios of the shared content view.
ZoomSDKCannotShareReasonType
Enumeration of reasons why sharing is not allowed.
ScreenType
Enumeration of screen types for multi-sharing.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKVideoFileSharePlayError
Enumeration of video file share play errors.
ZoomSDKShareContentType
Enumeration of types of shared content.
ZoomSDKShareSettingType
Enumeration of sharing types.
ZoomSDKAudioShareMode
Enumeration of the audio share modes.
The Zoom share controller responsible for managing screen sharing, annotation, and remote control fun...
ZoomSDKRemoteControllerHelper * _remoteControllerHelper
ZoomSDKCustomizedAnnotationCtr * _customizedAnnotationCtr
ZoomSDKAnnotationController * _annotationController
ZoomSDKShareContainer * _shareContainer
id< ZoomSDKASControllerDelegate > _delegate
Controls Zoom UI annotation features in Zoom meetings, including setting tools, clearing annotations,...
BOOL isAnnotationDisable()
Determines if annotation disabled.
NSString * getAnnotationLegalNoticesExplained()
Gets the annotation legal notices explained.
NSString * getAnnotationLegalNoticesPrompt()
Gets the annotation legal notices prompt.
BOOL isAnnotationLegalNoticeAvailable()
Determines whether the legal notice for annotation is available.
Controller class to create and manage customized annotations.
Helper class to manage remote control operations in Zoom meeting.
Container to manage all share elements.
Represents information about a sharing source.
CGWindowID windowID
Window ID of the shared application.
ZoomSDKShareContentType contentType
Content type of the shared source.
BOOL isShowInFirstScreen
Indicates if the content is shown on the first screen (Zoom UI mode only).
BOOL bEnableOptimizingVideoSharing
Determines if optimizing video sharing is enabled.
BOOL canBeRemoteControl
Indicates whether the shared content can be remote controlled.
unsigned int userID
User ID of the sharer.
BOOL isShowInSecondScreen
Indicates if the content is shown on the second screen (Zoom UI mode only).
ZoomSDKShareStatus status
Current status of the sharing.
unsigned int shareSourceID
Unique ID of the sharing source.
CGDirectDisplayID displayID
Display ID of the shared desktop.
Provides information about Zoom SDK split screen mode support and status.