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

#include <ZoomSDKMeetingWhiteboardController.h>

Inherits NSObject.

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

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

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

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

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

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

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

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

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

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

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

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

(BOOL)	- isParticipantsCreateWithoutHostEnabled
	Determines 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

Determines whether the current meeting can start sharing the whiteboard.

Parameters

reason The reason no one can start sharing the whiteboard.

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

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

◆ enableParticipantsCreateWithoutHost:

- (ZoomSDKError) enableParticipantsCreateWithoutHost: (BOOL) bEnable

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

Parameters

bEnable YES indicates to enable, NO otherwise.

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

◆ getWhiteboardCreateOption

- (ZoomSDKWhiteboardCreateOption) getWhiteboardCreateOption

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

Returns: The setting option for whiteboard who can initiate a new whiteboard.

Referenced by canStartShareWhiteboard:.

◆ getWhiteboardShareOption

- (ZoomSDKWhiteboardShareOption) getWhiteboardShareOption

Gets the option for who can share whiteboards.

Returns: 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 if they are sharing. Otherwise, NO.

Referenced by canStartShareWhiteboard:.

◆ isParticipantsCreateWithoutHostEnabled

- (BOOL) isParticipantsCreateWithoutHostEnabled

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

Returns: YES if that they have these permissions. Otherwise, NO.

Referenced by canStartShareWhiteboard:.

◆ isSharingWhiteboardOut

- (BOOL) isSharingWhiteboardOut

If the current user is successfully sharing a whiteboard.

Returns: YES if they are sharing. Otherwise, NO.

Referenced by canStartShareWhiteboard:.

◆ isSupportWhiteBoard

- (BOOL) isSupportWhiteBoard

Determines whether the current meeting supports the whiteboard or not.

Returns: YES if support. Otherwise, NO.

Referenced by canStartShareWhiteboard:.

◆ setDashboardViewSize:

- (ZoomSDKError) setDashboardViewSize: (NSSize) size

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

◆ setParentWindow:

- (ZoomSDKError) setParentWindow: (NSWindow *) window

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

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

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

◆ setWhiteboardShareOption:

- (ZoomSDKError) setWhiteboardShareOption: (ZoomSDKWhiteboardShareOption) option

Sets the option for who can share a whiteboard.

Parameters

option New setting for who can share a whiteboard.

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

◆ setWhiteboardViewPos:

- (ZoomSDKError) setWhiteboardViewPos: (NSPoint) point

Sets 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 screen's center where the owner window is located.

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

◆ setWhiteboardViewSize:

- (ZoomSDKError) setWhiteboardViewSize: (NSSize) size

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

◆ showDashboardView:

- (ZoomSDKError) showDashboardView: (NSPoint) point

Shows 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 screen's center where the owner window is located.

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

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