The Zoom share controller responsible for managing screen sharing, annotation, and remote control functionalities. More...

#include <ZoomSDKASController.h>

Inherits NSObject.

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

(BOOL)	- isShareAppValid:
	Determines if the application's window ID can be shared.

(ZoomSDKError)	- startMonitorShare:
	Starts to share desktop.

(ZoomSDKError)	- stopShare
	Stops the current share.

(NSArray< NSNumber * > *_Nullable)	- getViewableSharingUserList
	Gets the ID of users who are sharing.

(NSArray< ZoomSDKSharingSourceInfo * > *_Nullable)	- getSharingSourceInfoList:
	Gets the list of sharing source info.

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

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

(BOOL)	- canStartShare:
	Determines whether the current meeting can start sharing.

(BOOL)	- isShareLocked
	Determines if the share is locked by the host or co-host.

(BOOL)	- isDesktopSharingEnabled
	Determines if it is able to share desktop in the current meeting.

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

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

(ZoomSDKShareContainer *_Nullable)	- getShareContainer
	Gets custom share container.

(ZoomSDKRemoteControllerHelper *_Nullable)	- getRemoteControllerHelper
	Gets the class object of ZoomSDKRemoteControllerHelper.

(ZoomSDKError)	- startAnnotation:onScreen:
	Starts annotation.

(ZoomSDKError)	- startAnnotation:
	Starts annotation.

(ZoomSDKError)	- stopAnnotation:
	Stops annotation.

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

(ZoomSDKSplitScreenInfo *_Nullable)	- getCurrentSplitScreenModeInfo
	Gets 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
	Starts 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, only available for custom UI.

(ZoomSDKError)	- startShareCamera
	Share camera, only available for zoom UI.

(BOOL)	- canSwitchToShareNextCamera
	Determines if the user can share the next camera.

(ZoomSDKError)	- switchToShareNextCamera
	Share the next camera.

(ZoomSDKError)	- startVideoFileShare:
	Share video file.

(ZoomSDKError)	- startVideoFileShare:displayWindow:
	Share video file. Only available for custom UI.

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

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

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

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

(BOOL)	- canShareVideoFile
	Determines if users can share video files.

(BOOL)	- canEnableShareToBO
	Determines whether the user can share to the breakout room.

(BOOL)	- isShareToBOEnabled
	Determines if sharing to the breakout room is enabled.

(ZoomSDKError)	- enableShareToBO:
	Sets to enable sharing to the breakout room.

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

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

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

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

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

(BOOL)	- isEnableShareComputerSoundOn
	Determines if sharing computer sound option is on or off.

(BOOL)	- isEnableShareComputerSoundOnWhenSharing
	Determines if sharing computer sound option is on or off for the current sharing session.

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

(BOOL)	- isEnableOptimizeForFullScreenVideoClipOnWhenSharing
	Determines if optimizing for full screen video clip option is on or off for the current sharing session.

(BOOL)	- isSupportShareWithComputerSound:
	Determines if the specified share type supports sharing with computer sound.

(BOOL)	- isCurrentSharingSupportShareWithComputerSound
	Determines if current share support sharing with computer sound.

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

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

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

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

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

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

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

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

(NSString *)	- getWhiteboardLegalNoticesExplained
	Gets 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:
	Enables following the presenter's pointer by the function when watching the shared content on the specified view.

(ZoomSDKError)	- canEnableFollowPresenterPointerWhenViewShare:bCan:
	Determines if you can enable following the presenter's pointer 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
	The delegate to receive sharing and annotation event callbacks.

BOOL	enableShareComputerSound
	Enables or disable the shared computer sound, Applied when starting the share session.

BOOL	enableOptimizingScreenShareForVideoClip
	Enables or disable optimizing screen sharinge for a video clip, Applied when starting the share session.

Detailed Description

The Zoom share controller responsible for managing screen sharing, annotation, and remote control functionalities.

Definition at line 254 of file ZoomSDKASController.h.

Method Documentation

◆ canDisableViewerAnnotation:canDisabled:

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

Determines 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 indicates can disable, NO indicates cannot.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ canDoAnnotation:canAnnotate:

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

Determines 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 indicates can do annotation, NO indicates cannot.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ canEnableFollowPresenterPointerWhenViewShare:bCan:

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

Determines if you can enable following the presenter's pointer when watching the share on the specified view.

Parameters

shareSourceID	Specify the sharing source ID that you want to follow the presenter's pointer.
bCan	YES indicates that following the pointer can be enabled, NO indicates that it can't.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ canEnableShareToBO

- (BOOL) canEnableShareToBO

Determines whether the user can share to the breakout room.

Returns: YES if the user can share to the breakout room. Otherwise, NO.

Note: Valid for user custom interface mode only.

◆ canShareVideoFile

- (BOOL) canShareVideoFile

Determines if users can share video files.

Returns: YES if can. Otherwise, NO.

◆ canStartShare

- (BOOL) canStartShare

Determines if it is able for user to start sharing.

Returns: YES if that user can start share. Otherwise, NO.

Deprecated: Use ZoomSDKASController::canStartShare: instead.

◆ canStartShare:

- (BOOL) canStartShare: (ZoomSDKCannotShareReasonType *) reason

Determines whether the current meeting can start sharing.

Parameters

reason The reason that no one can start sharing.

Returns: YES if you can start sharing. Otherwise, NO.

◆ canSwitchToShareNextCamera

- (BOOL) canSwitchToShareNextCamera

Determines if the user can share the next camera.

Returns: YES if can. Otherwise, NO.

◆ cleanUp

- (void) cleanUp

Clean up as-controller object.

◆ disableViewerAnnotation:disable:

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

This method uses for the sharing user to disable or enable viewer's privilege of annotation.

Parameters

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

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableFollowPresenterPointerWhenViewShare:enable:

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

Enables following the presenter's pointer by the function when watching the shared content on the specified view.

Parameters

shareSourceID	Specify the sharing source ID that you want to follow the presenter's pointer.
enable	YES indicates to enable following the pointer, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableOptimizingScreenShareForVideoClip:

- (ZoomSDKError) enableOptimizingScreenShareForVideoClip: (BOOL) enable

Determines enable optimizing for full screen video clip.

Parameters

enable Enable or disable optimizing for full screen video clip.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableOptimizingScreenShareForVideoClipWhenSharing:

- (ZoomSDKError) enableOptimizingScreenShareForVideoClipWhenSharing: (BOOL) enable

Determines enable optimizing for full screen video clip when shaing.

Parameters

enable Enable or disable optimizing for full screen video clip.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableShareComputerSound:

- (ZoomSDKError) enableShareComputerSound: (BOOL) enable

Determines enable share computer sound.

Parameters

enable Enable or disable share computer sound.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableShareComputerSoundWhenSharing:

- (ZoomSDKError) enableShareComputerSoundWhenSharing: (BOOL) enable

Determines enable share computer sound when shaing.

Parameters

enable Enable or disable share computer sound.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableShareToBO:

- (ZoomSDKError) enableShareToBO: (BOOL) bEnable

Sets to enable sharing to the breakout room.

Parameters

bEnable YES indicates to enable, NO indicates that sharing to the breakout room is not enabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: Valid for user custom interface mode only.

◆ getAnnotationController

- (ZoomSDKAnnotationController *_Nullable) getAnnotationController

Gets the controller of annotation tools.

Returns: If the function succeeds, it returns the object of ZoomSDKAnnotationController. Otherwise, this function fails and returns nil.

◆ getAudioShareMode:

- (ZoomSDKError) getAudioShareMode: (ZoomSDKAudioShareMode *) mode

Gets the audio share mode.

Parameters

mode	The mode for audio share.

Returns: If the function succeeds, it returns ZoomSDKError_Success, the param mode will be the current audio share mode. Otherwise, this function returns an error.

◆ getCurrentRemoteController:

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

Gets the user ID of current remote controller.

Parameters

userID The ID of user who can remotely control others.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

Deprecated: This method is no longer used.

◆ getCurrentSplitScreenModeInfo

- (ZoomSDKSplitScreenInfo *_Nullable) getCurrentSplitScreenModeInfo

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

Returns: If the function succeeds, it returns a pointer to a ZoomSDKSplitScreenInfo object. Otherwise, this function fails and returns nil.

◆ getCustomizedAnnotationCtr

- (ZoomSDKCustomizedAnnotationCtr *_Nullable) getCustomizedAnnotationCtr

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

Returns: If the function succeeds, it returns the object of ZoomSDKCustomizedAnnotationCtr. Otherwise, this function fails and returns nil.

◆ getRemoteControllerHelper

- (ZoomSDKRemoteControllerHelper *_Nullable) getRemoteControllerHelper

Gets the class object of ZoomSDKRemoteControllerHelper.

Returns: If the function succeeds, it returns the object of ZoomSDKRemoteControllerHelper. Otherwise, this function fails and returns nil.

◆ getShareContainer

- (ZoomSDKShareContainer *_Nullable) getShareContainer

Gets custom share container.

Returns: If the function succeeds, it returns the object of ZoomSDKShareContainer. Otherwise, this function fails and returns nil.

◆ getSharingSourceInfoList:

- (NSArray< ZoomSDKSharingSourceInfo * > *_Nullable) getSharingSourceInfoList: (unsigned int) userID

Gets the list of sharing source info.

Parameters

userID The user's ID who is sharing.

Returns: If the function succeeds, it returns a pointer to the NSArray<ZoomSDKSharingSourceInfo*>. Otherwise, this function fails and returns nil.

◆ getViewableSharingUserList

- (NSArray< NSNumber * > *_Nullable) getViewableSharingUserList

Gets the ID of users who are sharing.

Returns: If the function succeeds, it returns an NSArray of user ID of all users who are sharing. Otherwise, this function fails and returns nil.

◆ getWhiteboardLegalNoticesExplained

- (NSString *) getWhiteboardLegalNoticesExplained

Gets the whiteboard legal notices explained.

Returns: If the function succeeds, it returns the whiteboard legal notices explained. Otherwise, this function fails and returns nil.

◆ getWhiteboardLegalNoticesPrompt

- (NSString *) getWhiteboardLegalNoticesPrompt

Gets the whiteboard legal notices prompt.

Returns: If the function succeeds, it returns the whiteboard legal notices prompt. Otherwise, this function fails and returns nil.

◆ isAbleToShareCamera

- (BOOL) isAbleToShareCamera

Determines if user can share camera.

Returns: YES if able. Otherwise, NO.

◆ isAbleToShareComputerAudio

- (BOOL) isAbleToShareComputerAudio

Determines if user can share computer audio.

Returns: YES if able. Otherwise, NO.

◆ isAbleToShareFrame

- (BOOL) isAbleToShareFrame

Determines if user can share a potion of screen.

Returns: YES if able. Otherwise, NO.

◆ isAbleToShareWhiteBoard

- (BOOL) isAbleToShareWhiteBoard

Determines if user can share white-board.

Returns: YES if able. Otherwise, NO.

◆ isCurrentSharingSupportShareWithComputerSound

- (BOOL) isCurrentSharingSupportShareWithComputerSound

Determines if current share support sharing with computer sound.

Returns: If supported, this return YES. Otherwise return NO.

◆ isDesktopSharingEnabled

- (BOOL) isDesktopSharingEnabled

Determines if it is able to share desktop in the current meeting.

Returns: YES if enabled. Otherwise, NO.

◆ isEnableOptimizeForFullScreenVideoClipOn

- (BOOL) isEnableOptimizeForFullScreenVideoClipOn

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

Returns: If enabled, this returns YES. Otherwise returns NO.

Deprecated: Use ZoomSDKASController::isEnableOptimizeForFullScreenVideoClipOnWhenSharing instead.

◆ isEnableOptimizeForFullScreenVideoClipOnWhenSharing

- (BOOL) isEnableOptimizeForFullScreenVideoClipOnWhenSharing

Determines if optimizing for full screen video clip option is on or off for the current sharing session.

Returns: If enabled, this returns YES. Otherwise returns NO.

◆ isEnableShareComputerSoundOn

- (BOOL) isEnableShareComputerSoundOn

Determines if sharing computer sound option is on or off.

Returns: If enabled, this returns YES. Otherwise returns NO.

Deprecated: Use ZoomSDKASController::isEnableShareComputerSoundOnWhenSharing instead.

◆ isEnableShareComputerSoundOnWhenSharing

- (BOOL) isEnableShareComputerSoundOnWhenSharing

Determines if sharing computer sound option is on or off for the current sharing session.

Returns: If enabled, this returns YES. Otherwise returns NO.

◆ isShareAppValid:

- (BOOL) isShareAppValid: (CGWindowID) windowID

Determines if the application's window ID can be shared.

Returns: YES if the current application window can be shared. Otherwise means the app's window handle can't be shared.

◆ isShareLocked

- (BOOL) isShareLocked

Determines if the share is locked by the host or co-host.

Returns: YES if that share is locked. Otherwise, NO.

Deprecated: This method is no longer used.

◆ isShareToBOEnabled

- (BOOL) isShareToBOEnabled

Determines if sharing to the breakout room is enabled.

Returns: YES if sharing is locked. Otherwise, NO.

Note: Valid for user custom interface mode only.

◆ isSupportEnableOptimizeForFullScreenVideoClip

- (BOOL) isSupportEnableOptimizeForFullScreenVideoClip

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

Returns: If supported, this returns YES. Otherwise returns NO.

◆ isSupportShareWithComputerSound:

- (BOOL) isSupportShareWithComputerSound: (ZoomSDKShareContentType) type

Determines if the specified share type supports sharing with computer sound.

Parameters

type	The type of shring content.

Returns: If supported, this return YES. Otherwise return NO.

◆ isViewerAnnotationLocked:isLocked:

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

Determines 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 indicates viewer's annotate privilege is locked, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ isWhiteboardLegalNoticeAvailable

- (BOOL) isWhiteboardLegalNoticeAvailable

Determines whether the legal notice for whiteboard is available.

Returns: YES if the legal notice for whiteboard is available. Otherwise, NO.

◆ setAudioShareMode:

- (ZoomSDKError) setAudioShareMode: (ZoomSDKAudioShareMode) mode

Sets the audio share mode.

Parameters

mode	The mode for audio share.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ startAnnotation:

- (ZoomSDKError) startAnnotation: (ScreenType) screen

Starts annotation.

Parameters

screen Specify the view where you want to place the annotation toolbar.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ startAnnotation:onScreen:

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

Starts 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 returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

Deprecated: Use ZoomSDKASController::startAnnotation: instead.

◆ startAppShare:

- (ZoomSDKError) startAppShare: (CGWindowID) windowID

Starts to share application.

Parameters

windowID The App window ID to be shared.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ startAudioShare

- (ZoomSDKError) startAudioShare

Share audio.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ startFrameShare

- (ZoomSDKError) startFrameShare

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

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ startMonitorShare:

- (ZoomSDKError) startMonitorShare: (CGDirectDisplayID) monitorID

Starts to share desktop.

Parameters

monitorID The monitor's ID that you want to display the shared content.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ startShareCamera

- (ZoomSDKError) startShareCamera

Share camera, only available for zoom UI.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ startShareCamera:displayWindow:

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

Share camera, only available for custom UI.

Parameters

deviceID	The camera's ID to be shared.
window	The view on which you want to show camera content.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ startVideoFileShare:

- (ZoomSDKError) startVideoFileShare: (NSString *) filePath

Share video file.

Parameters

filePath Specify the video file path. Only supports mov, mp4, or avi format.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ startVideoFileShare:displayWindow:

- (ZoomSDKError) startVideoFileShare:		(NSString *)	filePath
displayWindow:		(NSWindow *)	window

Share video file. Only available for custom UI.

Parameters

filePath	Specify the video file path. Only supports mov, mp4, or avi format.
window	The view where you want to show share content.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ startWhiteBoardShare

- (ZoomSDKError) startWhiteBoardShare

Share white-board.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ stopAnnotation:

- (ZoomSDKError) stopAnnotation: (ScreenType) screen

Stops annotation.

Parameters

screen Specify the view on which you want to stop annotating.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ stopShare

- (ZoomSDKError) stopShare

Stops the current share.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ 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 to enable side by side mode, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ switchToShareNextCamera

- (ZoomSDKError) switchToShareNextCamera

Share the next camera.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

◆ switchZoomRatioWhenViewShare:zoomRatio:

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

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

Parameters

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

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ viewShare:onScreen:

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

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

Parameters

shareSourceID	The share source ID of user that you want to view the shared content.
screen	Select the screen to display the shared content if you have more than one screen.

Returns: If the function succeeds, it returns ZoomSDKError_Succuss. Otherwise, this function returns an error.

Deprecated: This method is no longer used.

Field Documentation

◆ _annotationController

- (ZoomSDKAnnotationController*) _annotationController

protected

Definition at line 258 of file ZoomSDKASController.h.

◆ _customizedAnnotationCtr

- (ZoomSDKCustomizedAnnotationCtr*) _customizedAnnotationCtr

protected

Definition at line 259 of file ZoomSDKASController.h.

◆ _delegate

- (id<ZoomSDKASControllerDelegate>) _delegate

protected

Definition at line 256 of file ZoomSDKASController.h.

◆ _remoteControllerHelper

- (ZoomSDKRemoteControllerHelper*) _remoteControllerHelper

protected

Definition at line 260 of file ZoomSDKASController.h.

◆ _shareContainer

- (ZoomSDKShareContainer*) _shareContainer

protected

Definition at line 257 of file ZoomSDKASController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKASControllerDelegate>) delegate

readwritenonatomicassign

The delegate to receive sharing and annotation event callbacks.

Definition at line 265 of file ZoomSDKASController.h.

◆ enableOptimizingScreenShareForVideoClip

- (BOOL) enableOptimizingScreenShareForVideoClip

readwritenonatomicassign

Enables or disable optimizing screen sharinge for a video clip, Applied when starting the share session.

Definition at line 273 of file ZoomSDKASController.h.

◆ enableShareComputerSound

- (BOOL) enableShareComputerSound

readwritenonatomicassign

Enables or disable the shared computer sound, Applied when starting the share session.

Definition at line 269 of file ZoomSDKASController.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ canDisableViewerAnnotation:canDisabled:

◆ canDoAnnotation:canAnnotate:

◆ canEnableFollowPresenterPointerWhenViewShare:bCan:

◆ canEnableShareToBO

◆ canShareVideoFile

◆ canStartShare

◆ canStartShare:

◆ canSwitchToShareNextCamera

◆ cleanUp

◆ disableViewerAnnotation:disable:

◆ enableFollowPresenterPointerWhenViewShare:enable:

◆ enableOptimizingScreenShareForVideoClip:

◆ enableOptimizingScreenShareForVideoClipWhenSharing:

◆ enableShareComputerSound:

◆ enableShareComputerSoundWhenSharing:

◆ enableShareToBO:

◆ getAnnotationController

◆ getAudioShareMode:

◆ getCurrentRemoteController:

◆ getCurrentSplitScreenModeInfo

◆ getCustomizedAnnotationCtr

◆ getRemoteControllerHelper

◆ getShareContainer

◆ getSharingSourceInfoList:

◆ getViewableSharingUserList

◆ getWhiteboardLegalNoticesExplained

◆ getWhiteboardLegalNoticesPrompt

◆ isAbleToShareCamera

◆ isAbleToShareComputerAudio

◆ isAbleToShareFrame

◆ isAbleToShareWhiteBoard

◆ isCurrentSharingSupportShareWithComputerSound

◆ isDesktopSharingEnabled

◆ isEnableOptimizeForFullScreenVideoClipOn

◆ isEnableOptimizeForFullScreenVideoClipOnWhenSharing

◆ isEnableShareComputerSoundOn

◆ isEnableShareComputerSoundOnWhenSharing

◆ isShareAppValid:

◆ isShareLocked

◆ isShareToBOEnabled

◆ isSupportEnableOptimizeForFullScreenVideoClip

◆ isSupportShareWithComputerSound:

◆ isViewerAnnotationLocked:isLocked:

◆ isWhiteboardLegalNoticeAvailable

◆ setAudioShareMode:

◆ startAnnotation:

◆ startAnnotation:onScreen:

◆ startAppShare:

◆ startAudioShare

◆ startFrameShare

◆ startMonitorShare:

◆ startShareCamera

◆ startShareCamera:displayWindow:

◆ startVideoFileShare:

◆ startVideoFileShare:displayWindow:

◆ startWhiteBoardShare

◆ stopAnnotation:

◆ stopShare

◆ switchSplitScreenMode:

◆ switchToShareNextCamera

◆ switchZoomRatioWhenViewShare:zoomRatio:

◆ viewShare:onScreen:

Field Documentation

◆ _annotationController

◆ _customizedAnnotationCtr

◆ _delegate

◆ _remoteControllerHelper

◆ _shareContainer

Property Documentation

◆ delegate

◆ enableOptimizingScreenShareForVideoClip

◆ enableShareComputerSound