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
50- (ZoomSDKError)setColor:(float)red Green:(float)green Black:(float)black onScreen:(ScreenType)screen;
51
58- (ZoomSDKError)setLineWidth:(long)lineWidth onScreen:(ScreenType)screen;
59
65- (ZoomSDKError)undo:(ScreenType)screen;
66
72- (ZoomSDKError)redo:(ScreenType)screen;
73
79
85
91@end
92
93
98@interface ZoomSDKSharingSourceInfo: NSObject
102@property(nonatomic, assign, readonly) unsigned int shareSourceID;
106@property(nonatomic, assign, readonly) unsigned int userID;
110@property(nonatomic, assign, readonly) ZoomSDKShareContentType contentType;
114@property(nonatomic, assign, readonly) ZoomSDKShareStatus status;
118@property(nonatomic, assign, readonly) CGWindowID windowID;
122@property(nonatomic, assign, readonly) CGDirectDisplayID displayID;
126@property(nonatomic, assign, readonly) BOOL isShowInFirstScreen;
130@property(nonatomic, assign, readonly) BOOL isShowInSecondScreen;
134@property(nonatomic, assign, readonly) BOOL canBeRemoteControl;
138@property(nonatomic, assign, readonly) BOOL bEnableOptimizingVideoSharing;
139
144- (ZoomSDKError)getWindowID:(CGWindowID*)windowID;
145
150- (ZoomSDKError)getDisplayID:(CGDirectDisplayID*)displayID;
151@end
152
153
158@interface ZoomSDKSplitScreenInfo : NSObject
159{
162}
167- (BOOL)isInSplitScreenMode;
168
173- (BOOL)isSupportSplitScreenMode;
174@end
175
180@protocol ZoomSDKASControllerDelegate <NSObject>
181@optional
186- (void)onSharingStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
187
191- (void)onFailedToStartShare;
192
198- (void)onShareStatusLocked:(BOOL)shareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
199
204- (void)onShareContentChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
205
211- (void)onAnnotationSupportPropertyChanged:(BOOL)isSupportAnnotation shareSourceID:(unsigned int)shareSourceID;
212
217- (void)onShareSettingTypeChanged:(ZoomSDKShareSettingType)type;
218
222- (void)onSharedVideoEnded;
223
228- (void)onVideoFileSharePlayError:(ZoomSDKVideoFileSharePlayError)error;
229
234- (void)onOptimizingShareForVideoClipStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
235@end
236
237
238
243@interface ZoomSDKASController : NSObject
244{
245 id<ZoomSDKASControllerDelegate> _delegate;
250}
254@property(nonatomic, assign, nullable)id<ZoomSDKASControllerDelegate> delegate;
258@property(nonatomic, assign, readwrite) BOOL enableShareComputerSound;
262@property(nonatomic, assign, readwrite) BOOL enableOptimizingScreenShareForVideoClip;
263
269- (ZoomSDKError)startAppShare:(CGWindowID)windowID;
270
275- (BOOL)isShareAppValid:(CGWindowID)windowID;
276
282- (ZoomSDKError)startMonitorShare:(CGDirectDisplayID)monitorID;
283
288- (ZoomSDKError)stopShare;
289
294- (NSArray<NSNumber *>* _Nullable)getViewableSharingUserList;
295
301- (NSArray<ZoomSDKSharingSourceInfo *>* _Nullable)getSharingSourceInfoList:(unsigned int)userID;
302
310- (ZoomSDKError)viewShare:(unsigned int)shareSourceID onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("No longer used");
311
317- (BOOL)canStartShare DEPRECATED_MSG_ATTRIBUTE("Use -canStartShare: instead");
318
324- (BOOL)canStartShare:(ZoomSDKCannotShareReasonType*)reason;
325
331- (BOOL)isShareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
332
337- (BOOL)isDesktopSharingEnabled;
338
343- (ZoomSDKAnnotationController*_Nullable)getAnnotationController;
344
349- (ZoomSDKCustomizedAnnotationCtr*_Nullable)getCustomizedAnnotationCtr;
350
355- (ZoomSDKShareContainer*_Nullable)getShareContainer;
356
361- (ZoomSDKRemoteControllerHelper*_Nullable)getRemoteControllerHelper;
362
370- (ZoomSDKError)startAnnotation:(NSPoint)position onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("Use -startAnnotation: instead");
371
377- (ZoomSDKError)startAnnotation:(ScreenType)screen;
378
384- (ZoomSDKError)stopAnnotation:(ScreenType)screen;
385
392- (ZoomSDKError)getCurrentRemoteController:(unsigned int*)userID DEPRECATED_MSG_ATTRIBUTE("No longer used");
393
398- (ZoomSDKSplitScreenInfo*_Nullable)getCurrentSplitScreenModeInfo;
399
405- (ZoomSDKError)switchSplitScreenMode:(BOOL)switchTo;
406
410- (void)cleanUp;
411
416- (ZoomSDKError)startWhiteBoardShare;
417
422- (ZoomSDKError)startFrameShare;
423
428- (ZoomSDKError)startAudioShare;
429
436- (ZoomSDKError)startShareCamera:(NSString*)deviceID displayWindow:(NSWindow*)window;
437
442- (ZoomSDKError)startShareCamera;
443
448- (BOOL)canSwitchToShareNextCamera;
453- (ZoomSDKError)switchToShareNextCamera;
454
460- (ZoomSDKError)startVideoFileShare:(NSString*)filePath;
461
468- (ZoomSDKError)startVideoFileShare:(NSString*)filePath displayWindow:(NSWindow*)window;
469
474- (BOOL)isAbleToShareWhiteBoard;
479- (BOOL)isAbleToShareFrame;
484- (BOOL)isAbleToShareComputerAudio;
489- (BOOL)isAbleToShareCamera;
490
495- (BOOL)canShareVideoFile;
496
502- (BOOL)canEnableShareToBO;
503
509- (BOOL)isShareToBOEnabled;
510
517- (ZoomSDKError)enableShareToBO:(BOOL)bEnable;
518
525- (ZoomSDKError)disableViewerAnnotation:(ScreenType)screenType disable:(BOOL)disable;
526
533- (ZoomSDKError)isViewerAnnotationLocked:(ScreenType)screenType isLocked:(BOOL*)locked;
534
541- (ZoomSDKError)canDisableViewerAnnotation:(ScreenType)screenType canDisabled:(BOOL*)canDisable;
542
549- (ZoomSDKError)canDoAnnotation:(ScreenType)screenType canAnnotate:(BOOL*)canAnnotate;
550
555- (BOOL)isSupportEnableOptimizeForFullScreenVideoClip;
556
562- (BOOL)isEnableShareComputerSoundOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableShareComputerSoundOnWhenSharing instead");
563
568- (BOOL)isEnableShareComputerSoundOnWhenSharing;
569
575- (BOOL)isEnableOptimizeForFullScreenVideoClipOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableOptimizeForFullScreenVideoClipOnWhenSharing instead");
576
581- (BOOL)isEnableOptimizeForFullScreenVideoClipOnWhenSharing;
582
588- (BOOL)isSupportShareWithComputerSound:(ZoomSDKShareContentType)type;
589
594- (BOOL)isCurrentSharingSupportShareWithComputerSound;
595
601- (ZoomSDKError)enableShareComputerSound:(BOOL)enable;
602
608- (ZoomSDKError)enableOptimizingScreenShareForVideoClip:(BOOL)enable;
609
615- (ZoomSDKError)setAudioShareMode:(ZoomSDKAudioShareMode)mode;
616
622- (ZoomSDKError)getAudioShareMode:(ZoomSDKAudioShareMode*)mode;
623
629- (ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
630
636- (ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
637
642- (BOOL)isWhiteboardLegalNoticeAvailable;
643
648- (NSString *)getWhiteboardLegalNoticesPrompt;
649
654- (NSString *)getWhiteboardLegalNoticesExplained;
655
662- (ZoomSDKError)switchZoomRatioWhenViewShare:(unsigned int)shareSourceID zoomRatio:(ZoomSDKShareViewZoomRatio)zoomRatio;
663
670- (ZoomSDKError)enableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID enable:(BOOL)enable;
671
678- (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID bCan:(BOOL*)bCan;
679@end
680NS_ASSUME_NONNULL_END
681
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.