![]() |
Mac SDK
|
ZOOM share controller. More...
#import <ZoomSDKASController.h>
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... | |
Protected Attributes | |
id< ZoomSDKASControllerDelegate > | _delegate |
ZoomSDKShareContainer * | _shareContainer |
ZoomSDKAnnotationController * | _annotationController |
ZoomSDKCustomizedAnnotationCtr * | _customizedAnnotationCtr |
ZoomSDKRemoteControllerHelper * | _remoteControllerHelper |
Properties | |
id< ZoomSDKASControllerDelegate > | delegate |
ZOOM share controller.
- (ZoomSDKError) canDisableViewerAnnotation: | (ScreenType) | screenType | |
canDisabled: | (BOOL *) | canDisable | |
Determine if it is able for user to disable viewer's annotation privilege.
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. |
- (ZoomSDKError) canDoAnnotation: | (ScreenType) | screenType | |
canAnnotate: | (BOOL *) | canAnnotate | |
Determine if it is able for user to do annotation.
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. |
- (BOOL) canStartShare |
Determine if it is able for user to start sharing.
- (BOOL) canSwitchToShareNextCamera |
Determine if user can share next camera, only avaliable for ZOOM UI.
- (ZoomSDKError) disableViewerAnnotation: | (ScreenType) | screenType | |
disable: | (BOOL) | disable | |
This method is used for the sharing user to disable/enable viewer's privilege of annotation.
screenType | Select the screen where you want to operate on. |
disable | YES means disable viewer's annotation privilege, NO means enable. |
- (ZoomSDKAnnotationController*) getAnnotationController |
Get the controller of annotation tools.
- (ZoomSDKError) getCurrentRemoteController: | (unsigned int *) | userID |
Get the user ID of current remote controller.
userID | The ID of user who can remotely control others. |
- (ZoomSDKCustomizedAnnotationCtr*) getCustomizedAnnotationCtr |
Get the controller of annotation tools used in user custom interface mode.
- (ZoomSDKRemoteControllerHelper*) getRemoteControllerHelper |
Get the class object of ZoomSDKRemoteControllerHelper.
- (ZoomSDKShareContainer*) getShareContainer |
Get custom share container.
- (ZoomSDKShareSource*) getShareSourcebyUserId: | (unsigned int) | userID |
Choose the shared source with the specified user ID.
userID | The ID of user who is sharing. |
- (NSArray*) getShareSourceList |
Get the ID of users who are sharing.
- (BOOL) isAbleToShareCamera |
Determine if user can share camera.
- (BOOL) isAbleToShareComputerAudio |
Determine if user can share computer audio.
- (BOOL) isAbleToShareFrame |
Determine if user can share a potion of screen.
- (BOOL) isAbleToShareWhiteBoard |
Determine if user can share white-board.
- (BOOL) isShareLocked |
Determine if the share is locked by the host/co-host.
- (ZoomSDKError) isViewerAnnotationLocked: | (ScreenType) | screenType | |
isLocked: | (BOOL *) | locked | |
Determine whether the viewer's annotate privilege is locked.
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. |
- (ZoomSDKError) startAnnotation: | (NSPoint) | position | |
onScreen: | (ScreenType) | screen | |
Start annotation.
position | The position of annotation toolbar. |
screen | Specify the view where you want to place the annotation toolbar. |
- (ZoomSDKError) startAppShare: | (CGWindowID) | windowID |
Start to share application.
shareAppWindow | The App window to be shared. |
- (ZoomSDKError) startAudioShare |
Share audio.
- (ZoomSDKError) startFrameShare |
Start sharing a portion of screen by a frame. User can resize the shared range during sharing.
- (ZoomSDKError) startMonitorShare: | (CGDirectDisplayID) | monitorID |
Start to share desktop.
monitorID | The ID of the monitor that you want to display the shared content. |
- (ZoomSDKError) startShareCamera: | (NSString *) | deviceID | |
displayWindow: | (NSWindow *) | window | |
Share camera.
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. |
- (ZoomSDKError) startWhiteBoardShare |
Share white-board.
- (ZoomSDKError) stopAnnotation: | (ScreenType) | screen |
Stop annotation.
screen | Specify the view on which you want to stop annotating. |
- (ZoomSDKError) stopShare |
Stop the current share.
- (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.
switchTo | YES means to enable side by side mode, otherwise not. |
- (ZoomSDKError) switchToShareNextCamera |
Share next camera, only avaliable for ZOOM UI.
- (ZoomSDKError) viewShare: | (unsigned int) | userID | |
onScreen: | (ScreenType) | screen | |
View the user's shared content on the screen by the specified user ID.
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. |