macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKASController.h
Go to the documentation of this file.
2
3#import "ZoomSDKErrors.h"
10@interface ZoomSDKAnnotationController :NSObject
12- (ZoomSDKError)setTool:(AnnotationToolType)type onScreen:(ScreenType)screen;
13- (ZoomSDKError)clear:(AnnotationClearType)type onScreen:(ScreenType)screen;
14- (ZoomSDKError)setColor:(float)red Green:(float)green Black:(float)black onScreen:(ScreenType)screen;
15- (ZoomSDKError)setLineWidth:(long)lineWidth onScreen:(ScreenType)screen;
16- (ZoomSDKError)undo:(ScreenType)screen;
17- (ZoomSDKError)redo:(ScreenType)screen;
18
24
30
36@end
37
41@interface ZoomSDKShareSource :NSObject
42{
43 unsigned int _userID;
47
48}
49- (BOOL)isShowInFirstScreen;
50- (BOOL)isShowInSecondScreen;
51- (BOOL)canBeRemoteControl;
52- (unsigned int)getUserID;
53@end
54
58@interface ZoomSDKShareInfo: NSObject
59{
61 CGWindowID _windowID; //Specify the APP that user wants to share. Available only for _shareType = ZoomSDKShareContentType_AS.
62 CGDirectDisplayID _displayID; //Specify the device screen on which that user wants to share the content. Available only for _shareType = ZoomSDKShareContentType_DS.
63}
64- (ZoomSDKShareContentType) getShareType;
69- (ZoomSDKError)getWindowID:(CGWindowID*)windowID;
74- (ZoomSDKError)getDisplayID:(CGDirectDisplayID*)displayID;
75
76@end
77
81@interface ZoomSDKSplitScreenInfo : NSObject
82{
85}
86
87-(BOOL)isInSplitScreenMode;
88-(BOOL)isSupportSplitScreenMode;
89@end
90
94@protocol ZoomSDKASControllerDelegate <NSObject>
95@optional
102- (void)onSharingStatus:(ZoomSDKShareStatus)status User:(unsigned int)userID;
103
108- (void)onShareStatusLocked:(BOOL)shareLocked;
109
114- (void)onShareContentChanged:(ZoomSDKShareInfo*)shareInfo;
115
121- (void)onAnnotationSupportPropertyChanged:(BOOL)isSupportAnnotation shareSourceUserID:(unsigned int)userID;
122
127- (void)onShareSettingTypeChanged:(ZoomSDKShareSettingType)type;
128@end
129
130
134@interface ZoomSDKASController : NSObject
135{
136 id<ZoomSDKASControllerDelegate> _delegate;
141}
142@property(nonatomic, assign)id<ZoomSDKASControllerDelegate> delegate;
143
149- (ZoomSDKError)startAppShare:(CGWindowID)windowID;
150
156- (ZoomSDKError)startMonitorShare:(CGDirectDisplayID)monitorID;
157
162- (ZoomSDKError)stopShare;
163
168- (NSArray*)getShareSourceList;
169
175- (ZoomSDKShareSource*)getShareSourcebyUserId:(unsigned int)userID;
176
183- (ZoomSDKError)viewShare:(unsigned int) userID onScreen:(ScreenType)screen;
184
189- (BOOL)canStartShare;
190
195- (BOOL)isShareLocked;
196
201- (ZoomSDKAnnotationController*)getAnnotationController;
202
207- (ZoomSDKCustomizedAnnotationCtr*)getCustomizedAnnotationCtr;
208
213- (ZoomSDKShareContainer*)getShareContainer;
214
219- (ZoomSDKRemoteControllerHelper*)getRemoteControllerHelper;
220
227- (ZoomSDKError)startAnnotation:(NSPoint)position onScreen:(ScreenType)screen;
228
234- (ZoomSDKError)stopAnnotation:(ScreenType)screen;
235
241- (ZoomSDKError)getCurrentRemoteController:(unsigned int*)userID;
242
246- (ZoomSDKSplitScreenInfo*)getCurrentSplitScreenModeInfo;
247
252-(ZoomSDKError)switchSplitScreenMode:(BOOL)switchTo;
253
257- (void)cleanUp;
258
263- (ZoomSDKError)startWhiteBoardShare;
264
269- (ZoomSDKError)startFrameShare;
270
275- (ZoomSDKError)startAudioShare;
276
283- (ZoomSDKError)startShareCamera:(NSString*)deviceID displayWindow:(NSWindow*)window;
284
289- (BOOL)canSwitchToShareNextCamera;
294- (ZoomSDKError)switchToShareNextCamera;
295
300- (BOOL)isAbleToShareWhiteBoard;
305- (BOOL)isAbleToShareFrame;
310- (BOOL)isAbleToShareComputerAudio;
315- (BOOL)isAbleToShareCamera;
316
323- (ZoomSDKError)disableViewerAnnotation:(ScreenType)screenType disable:(BOOL)disable;
324
331- (ZoomSDKError)isViewerAnnotationLocked:(ScreenType)screenType isLocked:(BOOL*)locked;
332
339- (ZoomSDKError)canDisableViewerAnnotation:(ScreenType)screenType canDisabled:(BOOL*)canDisable;
340
347- (ZoomSDKError)canDoAnnotation:(ScreenType)screenType canAnnotate:(BOOL*)canAnnotate;
348
353- (BOOL)isSupportEnableOptimizeForFullScreenVideoClip;
354
359- (BOOL)isEnableShareComputerSoundOn;
360
365- (BOOL)isEnableOptimizeForFullScreenVideoClipOn;
366
372- (ZoomSDKError)enableShareComputerSound:(BOOL)enable;
373
379- (ZoomSDKError)enableOptimizingScreenShareForVideoClip:(BOOL)enable;
380
386- (ZoomSDKError)setAudioShareMode:(ZoomSDKAudioShareMode)mode;
387
393- (ZoomSDKError)getAudioShareMode:(ZoomSDKAudioShareMode*)mode;
394
400- (ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
401
407- (ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
408
413- (BOOL)isWhiteboardLegalNoticeAvailable;
414
419- (NSString *)getWhiteboardLegalNoticesPrompt;
420
425- (NSString *)getWhiteboardLegalNoticesExplained;
426
433- (ZoomSDKError)switchZoomRatioWhenViewShare:(unsigned int)userId zoomRatio:(ZoomSDKShareViewZoomRatio)zoomRatio;
434
441- (ZoomSDKError)enableFollowPresenterPointerWhenViewShare:(unsigned int)userId enable:(BOOL)enable;
442
449- (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)userID bCan:(BOOL*)bCan;
450@end
451
452
AnnotationToolType
Type of annotation tools.
ZoomSDKShareStatus
Enumeration of sharing status.
AnnotationClearType
Types of clearing annotations.
ZoomSDKShareViewZoomRatio
Enumerations of share view zoom ratio.
ScreenType
Enumeration of screen types for multi-sharing.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKShareContentType
Enumeration of types of shared content.
ZoomSDKShareSettingType
Enumerations of sharing types.
ZoomSDKAudioShareMode
Enumerations of the audio share mode.
ZOOM share controller.
ZoomSDKRemoteControllerHelper * _remoteControllerHelper
ZoomSDKCustomizedAnnotationCtr * _customizedAnnotationCtr
ZoomSDKAnnotationController * _annotationController
ZoomSDKShareContainer * _shareContainer
id< ZoomSDKASControllerDelegate > _delegate
ZOOM UI annotation class.
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.
ZOOM share information class.
ZoomSDKShareContentType _shareType
CGDirectDisplayID _displayID
ZOOM share source class.
ZOOM SDK split screen information class.