ZOOM share controller. More...

#import <ZoomSDKASController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- startAppShare:
	Start to share application.

(ZoomSDKError)	- startMonitorShare:
	Start to share desktop.

(ZoomSDKError)	- stopShare
	Stop the current share.

(NSArray *)	- getShareSourceList
	Get the ID of users who are sharing.

(ZoomSDKShareSource *)	- getShareSourcebyUserId:
	Choose the shared source with the specified user ID.

(ZoomSDKError)	- viewShare:onScreen:
	View the user's shared content on the screen by the specified user ID.

(BOOL)	- canStartShare
	Determine if it is able for user to start sharing.

(BOOL)	- isShareLocked
	Determine if the share is locked by the host/co-host.

(ZoomSDKAnnotationController *)	- getAnnotationController
	Get the controller of annotation tools.

(ZoomSDKCustomizedAnnotationCtr *)	- getCustomizedAnnotationCtr
	Get the controller of annotation tools used in user custom interface mode.

(ZoomSDKShareContainer *)	- getShareContainer
	Get custom share container.

(ZoomSDKRemoteControllerHelper *)	- getRemoteControllerHelper
	Get the class object of ZoomSDKRemoteControllerHelper.

(ZoomSDKError)	- startAnnotation:onScreen:
	Start annotation.

(ZoomSDKError)	- stopAnnotation:
	Stop annotation.

(ZoomSDKError)	- getCurrentRemoteController:
	Get the user ID of current remote controller.

(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.

(void)	- cleanUp
	Clean up as-controller object.

(ZoomSDKError)	- startWhiteBoardShare
	Share white-board.

(ZoomSDKError)	- startFrameShare
	Start sharing a portion of screen by a frame. User can resize the shared range during sharing.

(ZoomSDKError)	- startAudioShare
	Share audio.

(ZoomSDKError)	- startShareCamera:displayWindow:
	Share camera.

(BOOL)	- canSwitchToShareNextCamera
	Determine if user can share next camera, only avaliable for ZOOM UI.

(ZoomSDKError)	- switchToShareNextCamera
	Share next camera, only avaliable for ZOOM UI.

(BOOL)	- isAbleToShareWhiteBoard
	Determine if user can share white-board.

(BOOL)	- isAbleToShareFrame
	Determine if user can share a potion of screen.

(BOOL)	- isAbleToShareComputerAudio
	Determine if user can share computer audio.

(BOOL)	- isAbleToShareCamera
	Determine if user can share camera.

(ZoomSDKError)	- disableViewerAnnotation:disable:
	This method is used for the sharing user to disable/enable viewer's privilege of annotation.

(ZoomSDKError)	- isViewerAnnotationLocked:isLocked:
	Determine whether the viewer's annotate privilege is locked.

(ZoomSDKError)	- canDisableViewerAnnotation:canDisabled:
	Determine if it is able for user to disable viewer's annotation privilege.

(ZoomSDKError)	- canDoAnnotation:canAnnotate:
	Determine if it is able for user to do annotation.

(BOOL)	- isSupportEnableOptimizeForFullScreenVideoClip
	Determine if support enable or disable optimizing for full screen video clip.

(BOOL)	- isEnableShareComputerSoundOn
	Determine if share computer sound option is on or off.

(BOOL)	- isEnableOptimizeForFullScreenVideoClipOn
	Determine if optimizing for full screen video clip option is on or off.

(ZoomSDKError)	- enableShareComputerSound:
	Determine enable share computer sound.

(ZoomSDKError)	- enableOptimizingScreenShareForVideoClip:
	Determine enable optimizing for full screen video clip.

(ZoomSDKError)	- setAudioShareMode:
	Set the audio share mode.

(ZoomSDKError)	- getAudioShareMode:
	Get the audio share mode.

(ZoomSDKError)	- enableShareComputerSoundWhenSharing:
	Determine enable share computer sound when shaing.

(ZoomSDKError)	- enableOptimizingScreenShareForVideoClipWhenSharing:
	Determine enable optimizing for full screen video clip when shaing.

(BOOL)	- isWhiteboardLegalNoticeAvailable
	Determine whether the legal notice for whiteboard is available.

(NSString *)	- getWhiteboardLegalNoticesPrompt
	Get the whiteboard legal notices prompt.

(NSString *)	- getWhiteboardLegalNoticesExplained
	Get the whiteboard legal notices explained.

(ZoomSDKError)	- switchZoomRatioWhenViewShare:zoomRatio:
	Switch the window size by the function when watching the share on the specified view.

(ZoomSDKError)	- enableFollowPresenterPointerWhenViewShare:enable:
	Enable follow presenter's pointer by the function when watching the share on the specified view.

(ZoomSDKError)	- canEnableFollowPresenterPointerWhenViewShare:bCan:
	Determine if the follow presenter's pointer can be enabled when watching the share on the specified view.

Protected Attributes
id< ZoomSDKASControllerDelegate >	_delegate

ZoomSDKShareContainer *	_shareContainer

ZoomSDKAnnotationController *	_annotationController

ZoomSDKCustomizedAnnotationCtr *	_customizedAnnotationCtr

ZoomSDKRemoteControllerHelper *	_remoteControllerHelper

Properties
id< ZoomSDKASControllerDelegate >	delegate

Detailed Description

ZOOM share controller.

Definition at line 134 of file ZoomSDKASController.h.

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

screenType	Select the screen where you want to operate on.
canDisable	A 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

screenType	Select the screen where you want to operate on.
canAnnotate	A 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.

◆ canEnableFollowPresenterPointerWhenViewShare:bCan:

- (ZoomSDKError) canEnableFollowPresenterPointerWhenViewShare:	(unsigned int)	userID
bCan:	(BOOL *)	bCan

Determine if the follow presenter's pointer can be enabled when watching the share on the specified view.

Parameters

userID	Specify the sharing user ID that you want to follow his pointer.
bCan	YES indicates that the pointer can be enable. NO indicates that it can’t.

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

◆ 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.

◆ cleanUp

- (void) cleanUp

Clean up as-controller object.

◆ 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

screenType	Select the screen where you want to operate on.
disable	YES means disable viewer's annotation privilege, NO means enable.

Returns: A ZoomSDKError to tell client function call successful or not.

◆ enableFollowPresenterPointerWhenViewShare:enable:

- (ZoomSDKError) enableFollowPresenterPointerWhenViewShare:	(unsigned int)	userId
enable:	(BOOL)	enable

Enable follow presenter's pointer by the function when watching the share on the specified view.

Parameters

userId	Specify the sharing user ID that you want to follow his pointer.
enable	YES indicates to enable. otherwise not.

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

◆ enableOptimizingScreenShareForVideoClip:

- (ZoomSDKError) enableOptimizingScreenShareForVideoClip: (BOOL) enable

Determine enable optimizing for full screen video clip.

Parameters

enable Enable 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

enable Enable 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

enable Enable 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

enable Enable 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.

◆ getAudioShareMode:

- (ZoomSDKError) getAudioShareMode: (ZoomSDKAudioShareMode *) mode

Get the audio share mode.

Parameters

mode	The mode for audio share.

Returns: If the function succeeds, it will return ZoomSDKError_Success, the param mode will be the current audio share mode.

◆ getCurrentRemoteController:

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

Get the user ID of current remote controller.

Parameters

userID The ID of user who can remotely control others.

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

◆ getCurrentSplitScreenModeInfo

- (ZoomSDKSplitScreenInfo *) getCurrentSplitScreenModeInfo

Get the information of split screen when viewing the share in the meeting.

◆ 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

userID The 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.

◆ getWhiteboardLegalNoticesExplained

- (NSString *) getWhiteboardLegalNoticesExplained

Get the whiteboard legal notices explained.

Returns: If the function succeeds, it will return the whiteboard legal notices explained. Otherwise nil.

◆ getWhiteboardLegalNoticesPrompt

- (NSString *) getWhiteboardLegalNoticesPrompt

Get the whiteboard legal notices prompt.

Returns: If the function succeeds, it will return the whiteboard legal notices prompt. Otherwise nil.

◆ 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

screenType	Select the screen where you want to operate on.
locked	A 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.

◆ isWhiteboardLegalNoticeAvailable

- (BOOL) isWhiteboardLegalNoticeAvailable

Determine whether the legal notice for whiteboard is available.

Returns: YES indicates the legal notice for whiteboard is available. Otherwise not.

◆ setAudioShareMode:

- (ZoomSDKError) setAudioShareMode: (ZoomSDKAudioShareMode) mode

Set the audio share mode.

Parameters

mode	The mode for audio share.

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

◆ startAnnotation:onScreen:

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

Start annotation.

Parameters

position	The position of annotation toolbar.
screen	Specify 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

windowID The App window id 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

monitorID The 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

deviceID	The ID of camera to be shared.
window	The 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

screen Specify 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

switchTo YES 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.

◆ switchZoomRatioWhenViewShare:zoomRatio:

- (ZoomSDKError) switchZoomRatioWhenViewShare:	(unsigned int)	userId
zoomRatio:	(ZoomSDKShareViewZoomRatio)	zoomRatio

Switch the window size by the function when watching the share on the specified view.

Parameters

userId	Specify the sharing user ID that you want to switch zoom ratio.
zoomRatio	Specify the size you want to set.default is ZoomSDKShareViewZoomRatio_50,which means share content will zoom-out to 50%.

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

◆ 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

userID	The ID of user that you want to view the shared content.
screen	Select 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.

Field Documentation

◆ _annotationController

- (ZoomSDKAnnotationController*) _annotationController

protected

Definition at line 138 of file ZoomSDKASController.h.

◆ _customizedAnnotationCtr

- (ZoomSDKCustomizedAnnotationCtr*) _customizedAnnotationCtr

protected

Definition at line 139 of file ZoomSDKASController.h.

◆ _delegate

- (id<ZoomSDKASControllerDelegate>) _delegate

protected

Definition at line 136 of file ZoomSDKASController.h.

◆ _remoteControllerHelper

- (ZoomSDKRemoteControllerHelper*) _remoteControllerHelper

protected

Definition at line 140 of file ZoomSDKASController.h.

◆ _shareContainer

- (ZoomSDKShareContainer*) _shareContainer

protected

Definition at line 137 of file ZoomSDKASController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKASControllerDelegate>) delegate

readwritenonatomicassign

Definition at line 142 of file ZoomSDKASController.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ canDisableViewerAnnotation:canDisabled:

◆ canDoAnnotation:canAnnotate:

◆ canEnableFollowPresenterPointerWhenViewShare:bCan:

◆ canStartShare

◆ canSwitchToShareNextCamera

◆ cleanUp

◆ disableViewerAnnotation:disable:

◆ enableFollowPresenterPointerWhenViewShare:enable:

◆ enableOptimizingScreenShareForVideoClip:

◆ enableOptimizingScreenShareForVideoClipWhenSharing:

◆ enableShareComputerSound:

◆ enableShareComputerSoundWhenSharing:

◆ getAnnotationController

◆ getAudioShareMode:

◆ getCurrentRemoteController:

◆ getCurrentSplitScreenModeInfo

◆ getCustomizedAnnotationCtr

◆ getRemoteControllerHelper

◆ getShareContainer

◆ getShareSourcebyUserId:

◆ getShareSourceList

◆ getWhiteboardLegalNoticesExplained

◆ getWhiteboardLegalNoticesPrompt

◆ isAbleToShareCamera

◆ isAbleToShareComputerAudio

◆ isAbleToShareFrame

◆ isAbleToShareWhiteBoard

◆ isEnableOptimizeForFullScreenVideoClipOn

◆ isEnableShareComputerSoundOn

◆ isShareLocked

◆ isSupportEnableOptimizeForFullScreenVideoClip

◆ isViewerAnnotationLocked:isLocked:

◆ isWhiteboardLegalNoticeAvailable

◆ setAudioShareMode:

◆ startAnnotation:onScreen:

◆ startAppShare:

◆ startAudioShare

◆ startFrameShare

◆ startMonitorShare:

◆ startShareCamera:displayWindow:

◆ startWhiteBoardShare

◆ stopAnnotation:

◆ stopShare

◆ switchSplitScreenMode:

◆ switchToShareNextCamera

◆ switchZoomRatioWhenViewShare:zoomRatio:

◆ viewShare:onScreen:

Field Documentation

◆ _annotationController

◆ _customizedAnnotationCtr

◆ _delegate

◆ _remoteControllerHelper

◆ _shareContainer

Property Documentation

◆ delegate