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

#include <ZoomSDKASController.h>

Inherits NSObject.

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

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

(ZoomSDKError)	- startMonitorShare:
	Start to share desktop.

(ZoomSDKError)	- stopShare
	Stop the current share.

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

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

(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)	- canStartShare:
	Determine whether the current meeting can start sharing.

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

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

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

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

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

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

(ZoomSDKError)	- startAnnotation:onScreen:
	Start annotation.

(ZoomSDKError)	- startAnnotation:
	Start annotation.

(ZoomSDKError)	- stopAnnotation:
	Stop annotation.

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

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

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

(BOOL)	- canSwitchToShareNextCamera
	Determine 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
	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.

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

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

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

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

(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 sharing computer sound option is on or off.

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

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

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

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

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

(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 following the presenter's pointer by the function when watching the shared content on the specified view.

(ZoomSDKError)	- canEnableFollowPresenterPointerWhenViewShare:bCan:
	Determine 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
	Enable or disable the shared computer sound, which will be applied when starting the share session.

BOOL	enableOptimizingScreenShareForVideoClip
	Enable or disable optimizing screen sharinge for a video clip, which will be 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 243 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)	shareSourceID
bCan:		(BOOL *)	bCan

Determine 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 the function fails.

◆ canEnableShareToBO

- (BOOL) canEnableShareToBO

Determine whether the user can share to the breakout room.

Returns: YES indicates that the user can share to the breakout room. NO indicates that the function fails.

Note: Valid for user custom interface mode only.

◆ canShareVideoFile

- (BOOL) canShareVideoFile

Determine if users can share video files.

Returns: If the function succeeds, it returns YES. Otherwise the function fails and returns NO.

◆ canStartShare

- (BOOL) canStartShare

Determine if it is able for user to start sharing.

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

Deprecated: Use ZoomSDKASController::canStartShare: instead.

◆ canStartShare:

- (BOOL) canStartShare: (ZoomSDKCannotShareReasonType *) reason

Determine whether the current meeting can start sharing.

Parameters

reason The reason that no one can start sharing.

Returns: YES indicates you can start sharing, otherwise not.

◆ canSwitchToShareNextCamera

- (BOOL) canSwitchToShareNextCamera

Determine if the user can share the next camera.

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)	shareSourceID
enable:		(BOOL)	enable

Enable 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. Otherwise not.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise the function fails.

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

◆ enableShareToBO:

- (ZoomSDKError) enableShareToBO: (BOOL) bEnable

Set 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, the return value is ZoomSDKError_Success. Otherwise failed.

Note: Valid for user custom interface mode only.

◆ getAnnotationController

- (ZoomSDKAnnotationController *_Nullable) 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.

Deprecated: This method is no longer used.

◆ getCurrentSplitScreenModeInfo

- (ZoomSDKSplitScreenInfo *_Nullable) getCurrentSplitScreenModeInfo

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

Returns: If the function succeeds, it will return a pointer to a ZoomSDKSplitScreenInfo object. Otherwise nil.

◆ getCustomizedAnnotationCtr

- (ZoomSDKCustomizedAnnotationCtr *_Nullable) getCustomizedAnnotationCtr

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

Returns: The object of ZoomSDKCustomizedAnnotationCtr.

◆ getRemoteControllerHelper

- (ZoomSDKRemoteControllerHelper *_Nullable) getRemoteControllerHelper

Get the class object of ZoomSDKRemoteControllerHelper.

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

◆ getShareContainer

- (ZoomSDKShareContainer *_Nullable) getShareContainer

Get custom share container.

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

◆ getSharingSourceInfoList:

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

Get the list of sharing source info.

Parameters

userID The ID of the user who is sharing.

Returns: If the function succeeds, the return value is a pointer to the NSArray<ZoomSDKSharingSourceInfo*>. Otherwise, the return value is nil.

◆ getViewableSharingUserList

- (NSArray< NSNumber * > *_Nullable) getViewableSharingUserList

Get the ID of users who are sharing.

Returns: An NSArray of user ID 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.

◆ isCurrentSharingSupportShareWithComputerSound

- (BOOL) isCurrentSharingSupportShareWithComputerSound

Determine if current share support sharing with computer sound.

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

◆ isDesktopSharingEnabled

- (BOOL) isDesktopSharingEnabled

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

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 enabled, this returns YES. Otherwise returns NO.

Deprecated: Use ZoomSDKASController::isEnableOptimizeForFullScreenVideoClipOnWhenSharing instead.

◆ isEnableOptimizeForFullScreenVideoClipOnWhenSharing

- (BOOL) isEnableOptimizeForFullScreenVideoClipOnWhenSharing

Determine 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

Determine 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

Determine 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

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

Returns: YES indicates the current application window can be shared, otherwise means the app's window handle can't be shared.

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

Deprecated: This method is no longer used.

◆ isShareToBOEnabled

- (BOOL) isShareToBOEnabled

Determine if sharing to the breakout room is enabled.

Returns: YES indicates that the sharing is locked.

Note: Valid for user custom interface mode only.

◆ isSupportEnableOptimizeForFullScreenVideoClip

- (BOOL) isSupportEnableOptimizeForFullScreenVideoClip

Determine 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

Determine 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

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:

- (ZoomSDKError) startAnnotation: (ScreenType) screen

Start annotation.

Parameters

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

Returns: If the function succeeds, it will return ZoomSDKError_Succuss, 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.

Deprecated: Use ZoomSDKASController::startAnnotation: instead.

◆ 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

- (ZoomSDKError) startShareCamera

Share camera, only available for zoom UI.

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

◆ startShareCamera:displayWindow:

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

Share camera, only available for custom UI.

Parameters

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

Returns: If the function succeeds, it will return ZoomSDKError_Succuss. Oherwise not.

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

◆ 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 will return ZoomSDKError_Succuss. Oherwise 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.

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

◆ switchToShareNextCamera

- (ZoomSDKError) switchToShareNextCamera

Share the next camera.

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

◆ 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 the function fails.

◆ viewShare:onScreen:

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

View the user's 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 not.

Deprecated: This method is no longer used.

Field Documentation

◆ _annotationController

- (ZoomSDKAnnotationController*) _annotationController

protected

Definition at line 247 of file ZoomSDKASController.h.

◆ _customizedAnnotationCtr

- (ZoomSDKCustomizedAnnotationCtr*) _customizedAnnotationCtr

protected

Definition at line 248 of file ZoomSDKASController.h.

◆ _delegate

- (id<ZoomSDKASControllerDelegate>) _delegate

protected

Definition at line 245 of file ZoomSDKASController.h.

◆ _remoteControllerHelper

- (ZoomSDKRemoteControllerHelper*) _remoteControllerHelper

protected

Definition at line 249 of file ZoomSDKASController.h.

◆ _shareContainer

- (ZoomSDKShareContainer*) _shareContainer

protected

Definition at line 246 of file ZoomSDKASController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKASControllerDelegate>) delegate

readwritenonatomicassign

The delegate to receive sharing and annotation event callbacks.

Definition at line 254 of file ZoomSDKASController.h.

◆ enableOptimizingScreenShareForVideoClip

- (BOOL) enableOptimizingScreenShareForVideoClip

readwritenonatomicassign

Enable or disable optimizing screen sharinge for a video clip, which will be applied when starting the share session.

Definition at line 262 of file ZoomSDKASController.h.

◆ enableShareComputerSound

- (BOOL) enableShareComputerSound

readwritenonatomicassign

Enable or disable the shared computer sound, which will be applied when starting the share session.

Definition at line 258 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