Controller to manage whiteboard functionality during Zoom meetings. More...

#include <ZoomSDKMeetingWhiteboardController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- setParentWindow:
	Set the whiteboard web view and dashboard web view owner window.

(BOOL)	- isSupportWhiteBoard
	Determine whether the current meeting supports the whiteboard or not.

(BOOL)	- canStartShareWhiteboard:
	Determine whether the current meeting can start sharing the whiteboard.

(ZoomSDKError)	- showDashboardView:
	Show the dashboard web view window.

(ZoomSDKError)	- setDashboardViewSize:
	Set the dashboard web view window size.

(ZoomSDKError)	- setWhiteboardViewPos:
	Set the whiteboard web view window position.

(ZoomSDKError)	- setWhiteboardViewSize:
	Set the whiteboard web view window size.

(ZoomSDKError)	- setWhiteboardShareOption:
	Set the option for who can share a whiteboard.

(ZoomSDKWhiteboardShareOption)	- getWhiteboardShareOption
	Get the option for who can share whiteboards.

(ZoomSDKError)	- setWhiteboardCreateOption:
	Set the option for whiteboard who can initiate a new whiteboard.

(ZoomSDKWhiteboardCreateOption)	- getWhiteboardCreateOption
	Get the option for whiteboard who can initiate a new whiteboard.

(ZoomSDKError)	- enableParticipantsCreateWithoutHost:
	Enable the participants create a new whiteboard without the host in the meeting.

(BOOL)	- isParticipantsCreateWithoutHostEnabled
	Determine whether to enable the participants create a new whiteboard without the host in the meeting.

(BOOL)	- isOtherSharingWhiteboard
	Query if other user is sharing a whiteboard.

(BOOL)	- isSharingWhiteboardOut
	if the current user is successfully sharing a whiteboard.

Properties
id< ZoomSDKMeetingWhiteboardControllerDelegate >	delegate

Detailed Description

Controller to manage whiteboard functionality during Zoom meetings.

This class provides interfaces to control whiteboard display, settings, permissions, and status in a meeting environment.

Definition at line 48 of file ZoomSDKMeetingWhiteboardController.h.

Method Documentation

◆ canStartShareWhiteboard:

- (BOOL) canStartShareWhiteboard: (ZoomSDKCannotShareReasonType *) reason

Determine whether the current meeting can start sharing the whiteboard.

Parameters

reason The reason no one can start sharing the whiteboard.

Returns: YES indicates you can start sharing the whiteboard.

References delegate, getWhiteboardCreateOption, getWhiteboardShareOption, isOtherSharingWhiteboard, isParticipantsCreateWithoutHostEnabled, isSharingWhiteboardOut, and isSupportWhiteBoard.

◆ enableParticipantsCreateWithoutHost:

- (ZoomSDKError) enableParticipantsCreateWithoutHost: (BOOL) bEnable

Enable the participants create a new whiteboard without the host in the meeting.

Parameters

bEnable YES indicates to enable. NO is not.

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

◆ getWhiteboardCreateOption

- (ZoomSDKWhiteboardCreateOption) getWhiteboardCreateOption

Get the option for whiteboard who can initiate a new whiteboard.

Returns: The return value is the setting option for whiteboard who can initiate a new whiteboard.

Referenced by canStartShareWhiteboard:.

◆ getWhiteboardShareOption

- (ZoomSDKWhiteboardShareOption) getWhiteboardShareOption

Get the option for who can share whiteboards.

Returns: The return value is the setting option for who can share a whiteboard.

Referenced by canStartShareWhiteboard:.

◆ isOtherSharingWhiteboard

- (BOOL) isOtherSharingWhiteboard

Query if other user is sharing a whiteboard.

Returns: YES means that they are sharing, NO means that they are not.

Referenced by canStartShareWhiteboard:.

◆ isParticipantsCreateWithoutHostEnabled

- (BOOL) isParticipantsCreateWithoutHostEnabled

Determine whether to enable the participants create a new whiteboard without the host in the meeting.

Returns: YES indicates that they have these permissions.

Referenced by canStartShareWhiteboard:.

◆ isSharingWhiteboardOut

- (BOOL) isSharingWhiteboardOut

if the current user is successfully sharing a whiteboard.

Returns: YES means that they are sharing, NO means that they are not.

Referenced by canStartShareWhiteboard:.

◆ isSupportWhiteBoard

- (BOOL) isSupportWhiteBoard

Determine whether the current meeting supports the whiteboard or not.

Returns: YES indicates to support.

Referenced by canStartShareWhiteboard:.

◆ setDashboardViewSize:

- (ZoomSDKError) setDashboardViewSize: (NSSize) size

Set the dashboard web view window size.

Parameters

size	The size of display dashboard web view window. If the size is (0,0) the window size will be default size.

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

◆ setParentWindow:

- (ZoomSDKError) setParentWindow: (NSWindow *) window

Set the whiteboard web view and dashboard web view owner window.

Parameters

window Specify the owner window. If the window is nil, the desktop window will be the owner window.

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

Warning: This function should be called before call ShowDashboardView. Call this function before calling showDashboardView. Call this function when receiving the meeting status ZoomSDKMeetingStatus_InMeeting. Valid only for user custom interface mode.

◆ setWhiteboardCreateOption:

- (ZoomSDKError) setWhiteboardCreateOption: (ZoomSDKWhiteboardCreateOption) option

Set the option for whiteboard who can initiate a new whiteboard.

Parameters

option Setting option for who can initiate a new whiteboard.

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

◆ setWhiteboardShareOption:

- (ZoomSDKError) setWhiteboardShareOption: (ZoomSDKWhiteboardShareOption) option

Set the option for who can share a whiteboard.

Parameters

option New setting for who can share a whiteboard.

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

◆ setWhiteboardViewPos:

- (ZoomSDKError) setWhiteboardViewPos: (NSPoint) point

Set the whiteboard web view window position.

Parameters

point The original point to display dashboard web view window. If the point is (-1,-1) the window positon will be in the center of the screen where the owner window is located.

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

◆ setWhiteboardViewSize:

- (ZoomSDKError) setWhiteboardViewSize: (NSSize) size

Set the whiteboard web view window size.

Parameters

size	The size of display whiteboard web view window. If the size is (0,0) the window size will be default size.

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

◆ showDashboardView:

- (ZoomSDKError) showDashboardView: (NSPoint) point

Show the dashboard web view window.

Parameters

point The original point to display dashboard web view window. If the point is (-1,-1) the window positon will be in the center of the screen where the owner window is located.

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

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingWhiteboardControllerDelegate>) delegate

readwritenonatomicassign

Definition at line 49 of file ZoomSDKMeetingWhiteboardController.h.

Referenced by canStartShareWhiteboard:.

Instance Methods

Properties

Detailed Description

Method Documentation

◆ canStartShareWhiteboard:

◆ enableParticipantsCreateWithoutHost:

◆ getWhiteboardCreateOption

◆ getWhiteboardShareOption

◆ isOtherSharingWhiteboard

◆ isParticipantsCreateWithoutHostEnabled

◆ isSharingWhiteboardOut

◆ isSupportWhiteBoard

◆ setDashboardViewSize:

◆ setParentWindow:

◆ setWhiteboardCreateOption:

◆ setWhiteboardShareOption:

◆ setWhiteboardViewPos:

◆ setWhiteboardViewSize:

◆ showDashboardView:

Property Documentation

◆ delegate