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
16@interface ZoomSDKAnnotationController :NSObject
17
23
31- (ZoomSDKError)setTool:(AnnotationToolType)type onScreen:(ScreenType)screen;
32
39- (ZoomSDKError)clear:(AnnotationClearType)type onScreen:(ScreenType)screen;
40
49- (ZoomSDKError)setColor:(float)red Green:(float)green Black:(float)black onScreen:(ScreenType)screen;
50
57- (ZoomSDKError)setLineWidth:(long)lineWidth onScreen:(ScreenType)screen;
58
64- (ZoomSDKError)undo:(ScreenType)screen;
65
71- (ZoomSDKError)redo:(ScreenType)screen;
72
78
84
90@end
91
92
97@interface ZoomSDKSharingSourceInfo: NSObject
101@property(nonatomic, assign, readonly) unsigned int shareSourceID;
105@property(nonatomic, assign, readonly) unsigned int userID;
109@property(nonatomic, assign, readonly) ZoomSDKShareContentType contentType;
113@property(nonatomic, assign, readonly) ZoomSDKShareStatus status;
117@property(nonatomic, assign, readonly) CGWindowID windowID;
121@property(nonatomic, assign, readonly) CGDirectDisplayID displayID;
125@property(nonatomic, assign, readonly) BOOL isShowInFirstScreen;
129@property(nonatomic, assign, readonly) BOOL isShowInSecondScreen;
133@property(nonatomic, assign, readonly) BOOL canBeRemoteControl;
137@property(nonatomic, assign, readonly) BOOL bEnableOptimizingVideoSharing;
138
143- (ZoomSDKError)getWindowID:(CGWindowID*)windowID;
144
149- (ZoomSDKError)getDisplayID:(CGDirectDisplayID*)displayID;
150@end
151
152
157@interface ZoomSDKSplitScreenInfo : NSObject
158{
161}
166- (BOOL)isInSplitScreenMode;
167
172- (BOOL)isSupportSplitScreenMode;
173@end
174
179@protocol ZoomSDKASControllerDelegate <NSObject>
180@optional
185- (void)onSharingStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
186
190- (void)onFailedToStartShare;
191
197- (void)onShareStatusLocked:(BOOL)shareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
198
203- (void)onShareContentChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
204
210- (void)onAnnotationSupportPropertyChanged:(BOOL)isSupportAnnotation shareSourceID:(unsigned int)shareSourceID;
211
216- (void)onShareSettingTypeChanged:(ZoomSDKShareSettingType)type;
217
221- (void)onSharedVideoEnded;
222
227- (void)onVideoFileSharePlayError:(ZoomSDKVideoFileSharePlayError)error;
228
233- (void)onOptimizingShareForVideoClipStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
234@end
235
236
237
242@interface ZoomSDKASController : NSObject
243{
244 id<ZoomSDKASControllerDelegate> _delegate;
249}
253@property(nonatomic, assign, nullable)id<ZoomSDKASControllerDelegate> delegate;
257@property(nonatomic, assign, readwrite) BOOL enableShareComputerSound;
261@property(nonatomic, assign, readwrite) BOOL enableOptimizingScreenShareForVideoClip;
262
268- (ZoomSDKError)startAppShare:(CGWindowID)windowID;
269
274- (BOOL)isShareAppValid:(CGWindowID)windowID;
275
281- (ZoomSDKError)startMonitorShare:(CGDirectDisplayID)monitorID;
282
287- (ZoomSDKError)stopShare;
288
293- (NSArray<NSNumber *>* _Nullable)getViewableSharingUserList;
294
300- (NSArray<ZoomSDKSharingSourceInfo *>* _Nullable)getSharingSourceInfoList:(unsigned int)userID;
301
309- (ZoomSDKError)viewShare:(unsigned int)shareSourceID onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("No longer used");
310
316- (BOOL)canStartShare DEPRECATED_MSG_ATTRIBUTE("Use -canStartShare: instead");
317
323- (BOOL)canStartShare:(ZoomSDKCannotShareReasonType*)reason;
324
330- (BOOL)isShareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
331
336- (BOOL)isDesktopSharingEnabled;
337
342- (ZoomSDKAnnotationController*_Nullable)getAnnotationController;
343
348- (ZoomSDKCustomizedAnnotationCtr*_Nullable)getCustomizedAnnotationCtr;
349
354- (ZoomSDKShareContainer*_Nullable)getShareContainer;
355
360- (ZoomSDKRemoteControllerHelper*_Nullable)getRemoteControllerHelper;
361
369- (ZoomSDKError)startAnnotation:(NSPoint)position onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("Use -startAnnotation: instead");
370
376- (ZoomSDKError)startAnnotation:(ScreenType)screen;
377
383- (ZoomSDKError)stopAnnotation:(ScreenType)screen;
384
391- (ZoomSDKError)getCurrentRemoteController:(unsigned int*)userID DEPRECATED_MSG_ATTRIBUTE("No longer used");
392
397- (ZoomSDKSplitScreenInfo*_Nullable)getCurrentSplitScreenModeInfo;
398
404- (ZoomSDKError)switchSplitScreenMode:(BOOL)switchTo;
405
409- (void)cleanUp;
410
415- (ZoomSDKError)startWhiteBoardShare;
416
421- (ZoomSDKError)startFrameShare;
422
427- (ZoomSDKError)startAudioShare;
428
435- (ZoomSDKError)startShareCamera:(NSString*)deviceID displayWindow:(NSWindow*)window;
436
441- (ZoomSDKError)startShareCamera;
442
447- (BOOL)canSwitchToShareNextCamera;
452- (ZoomSDKError)switchToShareNextCamera;
453
459- (ZoomSDKError)startVideoFileShare:(NSString*)filePath;
460
467- (ZoomSDKError)startVideoFileShare:(NSString*)filePath displayWindow:(NSWindow*)window;
468
473- (BOOL)isAbleToShareWhiteBoard;
478- (BOOL)isAbleToShareFrame;
483- (BOOL)isAbleToShareComputerAudio;
488- (BOOL)isAbleToShareCamera;
489
494- (BOOL)canShareVideoFile;
495
501- (BOOL)canEnableShareToBO;
502
508- (BOOL)isShareToBOEnabled;
509
516- (ZoomSDKError)enableShareToBO:(BOOL)bEnable;
517
524- (ZoomSDKError)disableViewerAnnotation:(ScreenType)screenType disable:(BOOL)disable;
525
532- (ZoomSDKError)isViewerAnnotationLocked:(ScreenType)screenType isLocked:(BOOL*)locked;
533
540- (ZoomSDKError)canDisableViewerAnnotation:(ScreenType)screenType canDisabled:(BOOL*)canDisable;
541
548- (ZoomSDKError)canDoAnnotation:(ScreenType)screenType canAnnotate:(BOOL*)canAnnotate;
549
554- (BOOL)isSupportEnableOptimizeForFullScreenVideoClip;
555
561- (BOOL)isEnableShareComputerSoundOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableShareComputerSoundOnWhenSharing instead");
562
567- (BOOL)isEnableShareComputerSoundOnWhenSharing;
568
574- (BOOL)isEnableOptimizeForFullScreenVideoClipOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableOptimizeForFullScreenVideoClipOnWhenSharing instead");
575
580- (BOOL)isEnableOptimizeForFullScreenVideoClipOnWhenSharing;
581
587- (BOOL)isSupportShareWithComputerSound:(ZoomSDKShareContentType)type;
588
593- (BOOL)isCurrentSharingSupportShareWithComputerSound;
594
600- (ZoomSDKError)enableShareComputerSound:(BOOL)enable;
601
607- (ZoomSDKError)enableOptimizingScreenShareForVideoClip:(BOOL)enable;
608
614- (ZoomSDKError)setAudioShareMode:(ZoomSDKAudioShareMode)mode;
615
621- (ZoomSDKError)getAudioShareMode:(ZoomSDKAudioShareMode*)mode;
622
628- (ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
629
635- (ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
636
641- (BOOL)isWhiteboardLegalNoticeAvailable;
642
647- (NSString *)getWhiteboardLegalNoticesPrompt;
648
653- (NSString *)getWhiteboardLegalNoticesExplained;
654
661- (ZoomSDKError)switchZoomRatioWhenViewShare:(unsigned int)shareSourceID zoomRatio:(ZoomSDKShareViewZoomRatio)zoomRatio;
662
669- (ZoomSDKError)enableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID enable:(BOOL)enable;
670
677- (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID bCan:(BOOL*)bCan;
678@end
679NS_ASSUME_NONNULL_END
680
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()
Determine if annotation disabled.
NSString * getAnnotationLegalNoticesExplained()
Get the annotation legal notices explained.
NSString * getAnnotationLegalNoticesPrompt()
Get the annotation legal notices prompt.
BOOL isAnnotationLegalNoticeAvailable()
Determine 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.