MAC SDK
Instance Methods | Protected Attributes | Properties | List of all members
ZoomSDKASController Class Reference

ZOOM share controller. More...

#import <ZoomSDKASController.h>

Inheritance diagram for ZoomSDKASController:

Instance Methods

(ZoomSDKError) - startAppShare:
 Start to share application. More...
 
(ZoomSDKError) - startMonitorShare:
 Start to share desktop. More...
 
(ZoomSDKError) - stopShare
 Stop the current share. More...
 
(NSArray *) - getShareSourceList
 Get the ID of users who are sharing. More...
 
(ZoomSDKShareSource *) - getShareSourcebyUserId:
 Choose the shared source with the specified user ID. More...
 
(ZoomSDKError) - viewShare:onScreen:
 View the user's shared content on the screen by the specified user ID. More...
 
(BOOL) - canStartShare
 Determine if it is able for user to start sharing. More...
 
(BOOL) - isShareLocked
 Determine if the share is locked by the host/co-host. More...
 
(ZoomSDKAnnotationController *) - getAnnotationController
 Get the controller of annotation tools. More...
 
(ZoomSDKCustomizedAnnotationCtr *) - getCustomizedAnnotationCtr
 Get the controller of annotation tools used in user custom interface mode. More...
 
(ZoomSDKShareContainer *) - getShareContainer
 Get custom share container. More...
 
(ZoomSDKRemoteControllerHelper *) - getRemoteControllerHelper
 Get the class object of ZoomSDKRemoteControllerHelper. More...
 
(ZoomSDKError) - startAnnotation:onScreen:
 Start annotation. More...
 
(ZoomSDKError) - stopAnnotation:
 Stop annotation. More...
 
(ZoomSDKError) - getCurrentRemoteController:
 Get the user ID of current remote controller. More...
 
(ZoomSDKSplitScreenInfo *) - getCurrentSplitScreenModeInfo
 Get the information of split screen when viewing the share in the meeting.
 
(ZoomSDKError) - switchSplitScreenMode:
 Switch to split screen mode, which means that the shared content and the video are separated in different column, the video won't cover the shared content. More...
 
(void) - cleanUp
 Clean up as-controller object.
 
(ZoomSDKError) - startWhiteBoardShare
 Share white-board. More...
 
(ZoomSDKError) - startFrameShare
 Start sharing a portion of screen by a frame. User can resize the shared range during sharing. More...
 
(ZoomSDKError) - startAudioShare
 Share audio. More...
 
(ZoomSDKError) - startShareCamera:displayWindow:
 Share camera. More...
 
(BOOL) - canSwitchToShareNextCamera
 Determine if user can share next camera, only avaliable for ZOOM UI. More...
 
(ZoomSDKError) - switchToShareNextCamera
 Share next camera, only avaliable for ZOOM UI. More...
 
(BOOL) - isAbleToShareWhiteBoard
 Determine if user can share white-board. More...
 
(BOOL) - isAbleToShareFrame
 Determine if user can share a potion of screen. More...
 
(BOOL) - isAbleToShareComputerAudio
 Determine if user can share computer audio. More...
 
(BOOL) - isAbleToShareCamera
 Determine if user can share camera. More...
 
(ZoomSDKError) - disableViewerAnnotation:disable:
 This method is used for the sharing user to disable/enable viewer's privilege of annotation. More...
 
(ZoomSDKError) - isViewerAnnotationLocked:isLocked:
 Determine whether the viewer's annotate privilege is locked. More...
 
(ZoomSDKError) - canDisableViewerAnnotation:canDisabled:
 Determine if it is able for user to disable viewer's annotation privilege. More...
 
(ZoomSDKError) - canDoAnnotation:canAnnotate:
 Determine if it is able for user to do annotation. More...
 
(BOOL) - isSupportEnableOptimizeForFullScreenVideoClip
 Determine if support enable or disable optimizing for full screen video clip. More...
 
(BOOL) - isEnableShareComputerSoundOn
 Determine if share computer sound option is on or off. More...
 
(BOOL) - isEnableOptimizeForFullScreenVideoClipOn
 Determine if optimizing for full screen video clip option is on or off. More...
 
(ZoomSDKError) - enableShareComputerSound:
 Determine enable share computer sound. More...
 
(ZoomSDKError) - enableOptimizingScreenShareForVideoClip:
 Determine enable optimizing for full screen video clip. More...
 
(ZoomSDKError) - enableShareComputerSoundWhenSharing:
 Determine enable share computer sound when shaing. More...
 
(ZoomSDKError) - enableOptimizingScreenShareForVideoClipWhenSharing:
 Determine enable optimizing for full screen video clip when shaing. More...
 

Protected Attributes

id< ZoomSDKASControllerDelegate > _delegate
 
ZoomSDKShareContainer_shareContainer
 
ZoomSDKAnnotationController_annotationController
 
ZoomSDKCustomizedAnnotationCtr_customizedAnnotationCtr
 
ZoomSDKRemoteControllerHelper_remoteControllerHelper
 

Properties

id< ZoomSDKASControllerDelegate > delegate
 

Detailed Description

ZOOM share controller.

Method Documentation

◆ canDisableViewerAnnotation:canDisabled:()

- (ZoomSDKError) canDisableViewerAnnotation: (ScreenType)  screenType
canDisabled: (BOOL *)  canDisable 

Determine if it is able for user to disable viewer's annotation privilege.

Parameters
screenTypeSelect the screen where you want to operate on.
canDisableA point to A BOOL, if function call successfully, the value of 'canDisable' means whether the user can disable viewer's annotation, YES means can disable, NO means cannot.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ canDoAnnotation:canAnnotate:()

- (ZoomSDKError) canDoAnnotation: (ScreenType)  screenType
canAnnotate: (BOOL *)  canAnnotate 

Determine if it is able for user to do annotation.

Parameters
screenTypeSelect the screen where you want to operate on.
canAnnotateA point to A BOOL, if function call successfully, the value of 'canAnnotate' means whether the user can do annotation, YES means can do annotation, NO means cannot.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ canStartShare()

- (BOOL) canStartShare

Determine if it is able for user to start sharing.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ canSwitchToShareNextCamera()

- (BOOL) canSwitchToShareNextCamera

Determine if user can share next camera, only avaliable for ZOOM UI.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ disableViewerAnnotation:disable:()

- (ZoomSDKError) disableViewerAnnotation: (ScreenType)  screenType
disable: (BOOL)  disable 

This method is used for the sharing user to disable/enable viewer's privilege of annotation.

Parameters
screenTypeSelect the screen where you want to operate on.
disableYES means disable viewer's annotation privilege, NO means enable.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ enableOptimizingScreenShareForVideoClip:()

- (ZoomSDKError) enableOptimizingScreenShareForVideoClip: (BOOL)  enable

Determine enable optimizing for full screen video clip.

Parameters
enableEnable or disable optimizing for full screen video clip.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ enableOptimizingScreenShareForVideoClipWhenSharing:()

- (ZoomSDKError) enableOptimizingScreenShareForVideoClipWhenSharing: (BOOL)  enable

Determine enable optimizing for full screen video clip when shaing.

Parameters
enableEnable or disable optimizing for full screen video clip.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ enableShareComputerSound:()

- (ZoomSDKError) enableShareComputerSound: (BOOL)  enable

Determine enable share computer sound.

Parameters
enableEnable or disable share computer sound.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ enableShareComputerSoundWhenSharing:()

- (ZoomSDKError) enableShareComputerSoundWhenSharing: (BOOL)  enable

Determine enable share computer sound when shaing.

Parameters
enableEnable or disable share computer sound.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ getAnnotationController()

- (ZoomSDKAnnotationController*) getAnnotationController

Get the controller of annotation tools.

Returns
The object of ZoomSDKAnnotationController.

◆ getCurrentRemoteController:()

- (ZoomSDKError) getCurrentRemoteController: (unsigned int *)  userID

Get the user ID of current remote controller.

Parameters
userIDThe ID of user who can remotely control others.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ getCustomizedAnnotationCtr()

- (ZoomSDKCustomizedAnnotationCtr*) getCustomizedAnnotationCtr

Get the controller of annotation tools used in user custom interface mode.

Returns
The object of ZoomSDKCustomizedAnnotationCtr.

◆ getRemoteControllerHelper()

- (ZoomSDKRemoteControllerHelper*) getRemoteControllerHelper

Get the class object of ZoomSDKRemoteControllerHelper.

Returns
If the function succeeds, it will return the object of ZoomSDKRemoteControllerHelper, otherwise not.

◆ getShareContainer()

- (ZoomSDKShareContainer*) getShareContainer

Get custom share container.

Returns
If the function succeeds, it will return the object of ZoomSDKShareContainer, otherwise not.

◆ getShareSourcebyUserId:()

- (ZoomSDKShareSource*) getShareSourcebyUserId: (unsigned int)  userID

Choose the shared source with the specified user ID.

Parameters
userIDThe ID of user who is sharing.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ getShareSourceList()

- (NSArray*) getShareSourceList

Get the ID of users who are sharing.

Returns
A NSArray of userID of all users who are sharing.

◆ isAbleToShareCamera()

- (BOOL) isAbleToShareCamera

Determine if user can share camera.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isAbleToShareComputerAudio()

- (BOOL) isAbleToShareComputerAudio

Determine if user can share computer audio.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isAbleToShareFrame()

- (BOOL) isAbleToShareFrame

Determine if user can share a potion of screen.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isAbleToShareWhiteBoard()

- (BOOL) isAbleToShareWhiteBoard

Determine if user can share white-board.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isEnableOptimizeForFullScreenVideoClipOn()

- (BOOL) isEnableOptimizeForFullScreenVideoClipOn

Determine if optimizing for full screen video clip option is on or off.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isEnableShareComputerSoundOn()

- (BOOL) isEnableShareComputerSoundOn

Determine if share computer sound option is on or off.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isShareLocked()

- (BOOL) isShareLocked

Determine if the share is locked by the host/co-host.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isSupportEnableOptimizeForFullScreenVideoClip()

- (BOOL) isSupportEnableOptimizeForFullScreenVideoClip

Determine if support enable or disable optimizing for full screen video clip.

Returns
If support, it will return YES, otherwise not.

◆ isViewerAnnotationLocked:isLocked:()

- (ZoomSDKError) isViewerAnnotationLocked: (ScreenType)  screenType
isLocked: (BOOL *)  locked 

Determine whether the viewer's annotate privilege is locked.

Parameters
screenTypeSelect the screen where you want to operate on.
lockedA point to A BOOL, if function call successfully, the value of 'locked' means whether viewer's annotate privilege is locked, YES means viewer's annotate privilege is locked.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ startAnnotation:onScreen:()

- (ZoomSDKError) startAnnotation: (NSPoint)  position
onScreen: (ScreenType)  screen 

Start annotation.

Parameters
positionThe position of annotation toolbar.
screenSpecify the view where you want to place the annotation toolbar.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ startAppShare:()

- (ZoomSDKError) startAppShare: (CGWindowID)  windowID

Start to share application.

Parameters
shareAppWindowThe App window to be shared.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ startAudioShare()

- (ZoomSDKError) startAudioShare

Share audio.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ startFrameShare()

- (ZoomSDKError) startFrameShare

Start sharing a portion of screen by a frame. User can resize the shared range during sharing.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ startMonitorShare:()

- (ZoomSDKError) startMonitorShare: (CGDirectDisplayID)  monitorID

Start to share desktop.

Parameters
monitorIDThe ID of the monitor that you want to display the shared content.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ startShareCamera:displayWindow:()

- (ZoomSDKError) startShareCamera: (NSString *)  deviceID
displayWindow: (NSWindow *)  window 

Share camera.

Parameters
deviceIDThe ID of camera to be shared.
windowThe view on which you want to show camera content. If you want to user ZOOM UI, set it to nil.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ startWhiteBoardShare()

- (ZoomSDKError) startWhiteBoardShare

Share white-board.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ stopAnnotation:()

- (ZoomSDKError) stopAnnotation: (ScreenType)  screen

Stop annotation.

Parameters
screenSpecify the view on which you want to stop annotating.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ stopShare()

- (ZoomSDKError) stopShare

Stop the current share.

Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ switchSplitScreenMode:()

- (ZoomSDKError) switchSplitScreenMode: (BOOL)  switchTo

Switch to split screen mode, which means that the shared content and the video are separated in different column, the video won't cover the shared content.

Parameters
switchToYES means to enable side by side mode, otherwise not.

◆ switchToShareNextCamera()

- (ZoomSDKError) switchToShareNextCamera

Share next camera, only avaliable for ZOOM UI.

Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ viewShare:onScreen:()

- (ZoomSDKError) viewShare: (unsigned int)  userID
onScreen: (ScreenType)  screen 

View the user's shared content on the screen by the specified user ID.

Parameters
userIDThe ID of user that you want to view the shared content.
screenSelect the screen where you want to view the shared content if you have more than one screen.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

The documentation for this class was generated from the following file: