Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKASController.h
Go to the documentation of this file.
1
5
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;
124@property(nonatomic, assign, readonly) ZoomSDKShareContentType contentType;
128@property(nonatomic, assign, readonly) ZoomSDKShareStatus status;
132@property(nonatomic, assign, readonly) CGWindowID windowID;
136@property(nonatomic, assign, readonly) CGDirectDisplayID displayID;
140@property(nonatomic, assign, readonly) BOOL isShowInFirstScreen;
144@property(nonatomic, assign, readonly) BOOL isShowInSecondScreen;
148@property(nonatomic, assign, readonly) BOOL canBeRemoteControl;
152@property(nonatomic, assign, readonly) BOOL bEnableOptimizingVideoSharing;
153
158- (ZoomSDKError)getWindowID:(CGWindowID*)windowID;
159
164- (ZoomSDKError)getDisplayID:(CGDirectDisplayID*)displayID;
165@end
166
167
172@interface ZoomSDKSplitScreenInfo : NSObject
173{
176}
182
188@end
189
194@protocol ZoomSDKASControllerDelegate <NSObject>
195@optional
203- (void)onSharingStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
204
209
215- (void)onShareStatusLocked:(BOOL)shareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
216
221- (void)onShareContentChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
222
228- (void)onAnnotationSupportPropertyChanged:(BOOL)isSupportAnnotation shareSourceID:(unsigned int)shareSourceID;
229
234- (void)onShareSettingTypeChanged:(ZoomSDKShareSettingType)type;
235
240
245- (void)onVideoFileSharePlayError:(ZoomSDKVideoFileSharePlayError)error;
246
251- (void)onOptimizingShareForVideoClipStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
252@end
253
254
255
260@interface ZoomSDKASController : NSObject
261{
262 id<ZoomSDKASControllerDelegate> _delegate;
267}
271@property(nonatomic, assign, nullable)id<ZoomSDKASControllerDelegate> delegate;
275@property(nonatomic, assign, readwrite) BOOL enableShareComputerSound;
279@property(nonatomic, assign, readwrite) BOOL enableOptimizingScreenShareForVideoClip;
280
286- (ZoomSDKError)startAppShare:(CGWindowID)windowID;
287
292- (BOOL)isShareAppValid:(CGWindowID)windowID;
293
299- (ZoomSDKError)startMonitorShare:(CGDirectDisplayID)monitorID;
300
306
311- (NSArray<NSNumber *>* _Nullable)getViewableSharingUserList;
312
318- (NSArray<ZoomSDKSharingSourceInfo *>* _Nullable)getSharingSourceInfoList:(unsigned int)userID;
319
327- (ZoomSDKError)viewShare:(unsigned int)shareSourceID onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("No longer used");
328
334- (BOOL)canStartShare DEPRECATED_MSG_ATTRIBUTE("Use -canStartShare: instead");
335
342
348- (BOOL)isShareLocked DEPRECATED_MSG_ATTRIBUTE("No longer used");
349
355
361
367
373
379
387- (ZoomSDKError)startAnnotation:(NSPoint)position onScreen:(ScreenType)screen DEPRECATED_MSG_ATTRIBUTE("Use -startAnnotation: instead");
388
394- (ZoomSDKError)startAnnotation:(ScreenType)screen;
395
401- (ZoomSDKError)stopAnnotation:(ScreenType)screen;
402
409- (ZoomSDKError)getCurrentRemoteController:(unsigned int*)userID DEPRECATED_MSG_ATTRIBUTE("No longer used");
410
416
422- (ZoomSDKError)switchSplitScreenMode:(BOOL)switchTo;
423
427- (void)cleanUp;
428
434
440
446
453- (ZoomSDKError)startShareCamera:(NSString*)deviceID displayWindow:(NSWindow*)window;
454
460
471
477- (ZoomSDKError)startVideoFileShare:(NSString*)filePath;
478
485- (ZoomSDKError)startVideoFileShare:(NSString*)filePath displayWindow:(NSWindow*)window;
486
507
513
520
527
534- (ZoomSDKError)enableShareToBO:(BOOL)bEnable;
535
542- (ZoomSDKError)disableViewerAnnotation:(ScreenType)screenType disable:(BOOL)disable;
543
550- (ZoomSDKError)isViewerAnnotationLocked:(ScreenType)screenType isLocked:(BOOL*)locked;
551
558- (ZoomSDKError)canDisableViewerAnnotation:(ScreenType)screenType canDisabled:(BOOL*)canDisable;
559
566- (ZoomSDKError)canDoAnnotation:(ScreenType)screenType canAnnotate:(BOOL*)canAnnotate;
567
573
579- (BOOL)isEnableShareComputerSoundOn DEPRECATED_MSG_ATTRIBUTE("Use -isEnableShareComputerSoundOnWhenSharing instead");
580
586
593
599
605- (BOOL)isSupportShareWithComputerSound:(ZoomSDKShareContentType)type;
606
612
619
626
632- (ZoomSDKError)setAudioShareMode:(ZoomSDKAudioShareMode)mode;
633
639- (ZoomSDKError)getAudioShareMode:(ZoomSDKAudioShareMode*)mode;
640
646- (ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
647
653- (ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
654
660
666
672
679- (ZoomSDKError)switchZoomRatioWhenViewShare:(unsigned int)shareSourceID zoomRatio:(ZoomSDKShareViewZoomRatio)zoomRatio;
680
687- (ZoomSDKError)enableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID enable:(BOOL)enable;
688
695- (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID bCan:(BOOL*)bCan;
696@end
697NS_ASSUME_NONNULL_END
698
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
ZoomSDKRemoteControllerHelper *_Nullable getRemoteControllerHelper()
Gets the class object of ZoomSDKRemoteControllerHelper.
ZoomSDKAnnotationController *_Nullable getAnnotationController()
Gets the controller of annotation tools.
BOOL isShareToBOEnabled()
Determines if sharing to the breakout room is enabled.
BOOL isAbleToShareWhiteBoard()
Determines if user can share white-board.
ZoomSDKError startShareCamera()
Share camera, only available for zoom UI.
BOOL isEnableShareComputerSoundOn()
Determines if sharing computer sound option is on or off.
ZoomSDKError startAudioShare()
Share audio.
ZoomSDKCustomizedAnnotationCtr * _customizedAnnotationCtr
id< ZoomSDKASControllerDelegate > delegate
The delegate to receive sharing and annotation event callbacks.
NSArray< NSNumber * > *_Nullable getViewableSharingUserList()
Gets the ID of users who are sharing.
NSString * getWhiteboardLegalNoticesPrompt()
Gets the whiteboard legal notices prompt.
ZoomSDKShareContainer *_Nullable getShareContainer()
Gets custom share container.
ZoomSDKAnnotationController * _annotationController
ZoomSDKCustomizedAnnotationCtr *_Nullable getCustomizedAnnotationCtr()
Gets the controller of annotation tools used in user custom interface mode.
BOOL enableShareComputerSound
Enables or disable the shared computer sound, Applied when starting the share session.
BOOL isShareLocked()
Determines if the share is locked by the host or co-host.
ZoomSDKError startFrameShare()
Starts sharing a portion of screen by a frame. User can resize the shared range during sharing.
ZoomSDKError startWhiteBoardShare()
Share white-board.
BOOL isDesktopSharingEnabled()
Determines if it is able to share desktop in the current meeting.
NSString * getWhiteboardLegalNoticesExplained()
Gets the whiteboard legal notices explained.
BOOL isSupportEnableOptimizeForFullScreenVideoClip()
Determines if support enable or disable optimizing for full screen video clip.
ZoomSDKSplitScreenInfo *_Nullable getCurrentSplitScreenModeInfo()
Gets the information of split screen when viewing the share in the meeting.
BOOL isEnableOptimizeForFullScreenVideoClipOnWhenSharing()
Determines if optimizing for full screen video clip option is on or off for the current sharing sessi...
BOOL isEnableOptimizeForFullScreenVideoClipOn()
Determines if optimizing for full screen video clip option is on or off.
BOOL canStartShare()
Determines if it is able for user to start sharing.
BOOL canShareVideoFile()
Determines if users can share video files.
BOOL canSwitchToShareNextCamera()
Determines if the user can share the next camera.
BOOL isAbleToShareComputerAudio()
Determines if user can share computer audio.
BOOL isAbleToShareFrame()
Determines if user can share a potion of screen.
BOOL isAbleToShareCamera()
Determines if user can share camera.
BOOL canEnableShareToBO()
Determines whether the user can share to the breakout room.
BOOL isCurrentSharingSupportShareWithComputerSound()
Determines if current share support sharing with computer sound.
BOOL isWhiteboardLegalNoticeAvailable()
Determines whether the legal notice for whiteboard is available.
ZoomSDKShareContainer * _shareContainer
BOOL enableOptimizingScreenShareForVideoClip
Enables or disable optimizing screen sharinge for a video clip, Applied when starting the share sessi...
BOOL isEnableShareComputerSoundOnWhenSharing()
Determines if sharing computer sound option is on or off for the current sharing session.
ZoomSDKError stopShare()
Stops the current share.
void cleanUp()
Clean up as-controller object.
ZoomSDKError switchToShareNextCamera()
Share the next camera.
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.
BOOL isInSplitScreenMode()
Determines whether the current mode is split screen.
BOOL isSupportSplitScreenMode()
Determines whether split screen mode is supported.
void onFailedToStartShare()
Notification of failure to start sharing.
void onSharedVideoEnded()
The shared video’s playback has completed.