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
12
16typedef NS_ENUM(NSUInteger, ZoomSDKVideoSharingQuality) {
18 ZoomSDKVideoSharingQuality_None,
20 ZoomSDKVideoSharingQuality_720p_30fps,
22 ZoomSDKVideoSharingQuality_720p_60fps,
24 ZoomSDKVideoSharingQuality_1080p_30fps,
26 ZoomSDKVideoSharingQuality_1080p_60fps,
27};
28
34@interface ZoomSDKAnnotationController :NSObject
35
41
49- (ZoomSDKError)setTool:(AnnotationToolType)type onScreen:(ScreenType)screen;
50
57- (ZoomSDKError)clear:(AnnotationClearType)type onScreen:(ScreenType)screen;
58
67- (ZoomSDKError)setColor:(float)red green:(float)green blue:(float)blue onScreen:(ScreenType)screen;
68
75- (ZoomSDKError)setLineWidth:(long)lineWidth onScreen:(ScreenType)screen;
76
82- (ZoomSDKError)undo:(ScreenType)screen;
83
89- (ZoomSDKError)redo:(ScreenType)screen;
90
96
102
108@end
109
110
115@interface ZoomSDKSharingSourceInfo: NSObject
119@property(nonatomic, assign, readonly) unsigned int shareSourceID;
123@property(nonatomic, assign, readonly) unsigned int userID;
130@property(nonatomic, assign, readonly) ZoomSDKShareContentType contentType;
134@property(nonatomic, assign, readonly) ZoomSDKShareStatus status;
138@property(nonatomic, assign, readonly) CGWindowID windowID;
142@property(nonatomic, assign, readonly) CGDirectDisplayID displayID;
146@property(nonatomic, assign, readonly) BOOL isShowInFirstScreen;
150@property(nonatomic, assign, readonly) BOOL isShowInSecondScreen;
154@property(nonatomic, assign, readonly) BOOL canBeRemoteControl;
158@property(nonatomic, assign, readonly) BOOL bEnableOptimizingVideoSharing;
159
164- (ZoomSDKError)getWindowID:(CGWindowID*)windowID;
165
170- (ZoomSDKError)getDisplayID:(CGDirectDisplayID*)displayID;
171@end
172
173
178@interface ZoomSDKSplitScreenInfo : NSObject
179{
182}
188
194@end
195
200@protocol ZoomSDKASControllerDelegate <NSObject>
201@optional
209- (void)onSharingStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
210
215
220- (void)onShareContentChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
221
227- (void)onAnnotationSupportPropertyChanged:(BOOL)isSupportAnnotation shareSourceID:(unsigned int)shareSourceID;
228
233- (void)onShareSettingTypeChanged:(ZoomSDKShareSettingType)type;
234
239
244- (void)onVideoFileSharePlayError:(ZoomSDKVideoFileSharePlayError)error;
245
250- (void)onOptimizingShareForVideoClipStatusChanged:(ZoomSDKSharingSourceInfo*)shareInfo;
251
256- (void)onVideoSharingQualityChanged:(ZoomSDKVideoSharingQuality)quality;
257@end
258
259
260
265@interface ZoomSDKASController : NSObject
266{
267 id<ZoomSDKASControllerDelegate> _delegate;
272}
276@property(nonatomic, assign, nullable)id<ZoomSDKASControllerDelegate> delegate;
280@property(nonatomic, assign, readwrite) BOOL enableShareComputerSound;
284@property(nonatomic, assign, readwrite) BOOL enableOptimizingScreenShareForVideoClip;
285
291- (ZoomSDKError)startAppShare:(CGWindowID)windowID;
292
297- (BOOL)isShareAppValid:(CGWindowID)windowID;
298
304- (ZoomSDKError)startMonitorShare:(CGDirectDisplayID)monitorID;
305
311
316- (NSArray<NSNumber *>* _Nullable)getViewableSharingUserList;
317
323- (NSArray<ZoomSDKSharingSourceInfo *>* _Nullable)getSharingSourceInfoList:(unsigned int)userID;
324
330- (BOOL)canStartShare:(ZoomSDKCannotShareReasonType*)reason;
331
332
338
344
350
356
362
368- (ZoomSDKError)startAnnotation:(ScreenType)screen;
369
375- (ZoomSDKError)stopAnnotation:(ScreenType)screen;
376
382
388- (ZoomSDKError)switchSplitScreenMode:(BOOL)switchTo;
389
393- (void)cleanUp;
394
400
406
412
419- (ZoomSDKError)startShareCamera:(NSString*)deviceID displayWindow:(NSWindow*)window;
420
426
437
443- (ZoomSDKError)startVideoFileShare:(NSString*)filePath;
444
451- (ZoomSDKError)startVideoFileShare:(NSString*)filePath displayWindow:(NSWindow*)window;
452
473
479
486
493
500- (ZoomSDKError)enableShareToBO:(BOOL)bEnable;
501
508- (ZoomSDKError)disableViewerAnnotation:(ScreenType)screenType disable:(BOOL)disable;
509
516- (ZoomSDKError)isViewerAnnotationLocked:(ScreenType)screenType isLocked:(BOOL*)locked;
517
524- (ZoomSDKError)canDisableViewerAnnotation:(ScreenType)screenType canDisabled:(BOOL*)canDisable;
525
532- (ZoomSDKError)canDoAnnotation:(ScreenType)screenType canAnnotate:(BOOL*)canAnnotate;
533
539
545
551
557- (BOOL)isSupportShareWithComputerSound:(ZoomSDKShareContentType)type;
558
564
571
578
584- (ZoomSDKError)setAudioShareMode:(ZoomSDKAudioShareMode)mode;
585
591- (ZoomSDKError)getAudioShareMode:(ZoomSDKAudioShareMode*)mode;
592
598- (ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
599
605- (ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
606
612
618
624
631- (ZoomSDKError)switchZoomRatioWhenViewShare:(unsigned int)shareSourceID zoomRatio:(ZoomSDKShareViewZoomRatio)zoomRatio;
632
639- (ZoomSDKError)enableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID enable:(BOOL)enable;
640
647- (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)shareSourceID bCan:(BOOL*)bCan;
648
657- (BOOL)canSetVideoSharingQuality:(ZoomSDKVideoSharingQuality)quality
658 forShareType:(ZoomSDKShareContentType)shareType;
659
669- (ZoomSDKError)setVideoSharingQuality:(ZoomSDKVideoSharingQuality)quality;
670
677- (ZoomSDKVideoSharingQuality)getVideoSharingQuality;
678
679@end
680NS_ASSUME_NONNULL_END
NS_ASSUME_NONNULL_BEGIN typedef NS_ENUM(NSUInteger, ZoomSDKVideoSharingQuality)
Video sharing quality options.
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.
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.
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 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.
ZoomSDKVideoSharingQuality getVideoSharingQuality()
Gets the current video sharing quality.
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.