The whiteboard helper interface. More...

#include <ZoomVideoSDKWhiteboardHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- subscribeWhiteboard:
	Displays the whiteboard view when someone is sharing the whiteboard.

(ZoomVideoSDKError)	- unSubscribeWhiteboard
	Hides the whiteboard sharing view when someone is sharing the whiteboard.

(BOOL)	- canStartShareWhiteboard
	Checks whether the current user can start whiteboard sharing. Only the host can start whiteboard sharing.

(ZoomVideoSDKError)	- startShareWhiteboard
	Starts whiteboard sharing in the session.

(BOOL)	- canStopShareWhiteboard
	Checks whether the current user can stop whiteboard sharing.

(ZoomVideoSDKError)	- stopShareWhiteboard
	Stops whiteboard sharing in the session.

(BOOL)	- isOtherSharingWhiteboard
	Checks whether another user is currently sharing a whiteboard.

(ZoomVideoSDKError)	- exportWhiteboard:
	Exports the currently shared whiteboard.

Detailed Description

The whiteboard helper interface.

Note

IMPORTANT: To prevent whiteboard data loss, developers must call exportWhiteboard: before the following scenarios:

Closing the whiteboard (calling stopShareWhiteboard)
Leaving the session (calling ZoomVideoSDK::leaveSession)
Joining a sub-session (calling SubSessionKit::joinSubSession or SubSessionKit::joinSubSessionByUserRequest) KNOWN ISSUE: Data loss is unavoidable in crash or failover scenarios. To minimize potential data loss, implement periodic auto-save functionality using exportWhiteboard:.

Definition at line 19 of file ZoomVideoSDKWhiteboardHelper.h.

Method Documentation

◆ canStartShareWhiteboard

- (BOOL) canStartShareWhiteboard

Checks whether the current user can start whiteboard sharing. Only the host can start whiteboard sharing.

Returns: true if the user can start whiteboard sharing, otherwise it returns false.

Note: The whiteboard service is an add-on, be sure to enable it by package zm-annoter & whiteboard module, otherwise this method will always returns false.

◆ canStopShareWhiteboard

- (BOOL) canStopShareWhiteboard

Checks whether the current user can stop whiteboard sharing.

Returns: true if the user can stop whiteboard sharing, otherwise it returns false.

◆ exportWhiteboard:

- (ZoomVideoSDKError) exportWhiteboard: (ZoomVideoSDKWhiteboardExportFormatType) format

Exports the currently shared whiteboard.

Parameters

format The export format.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKErrors enum.

Note: The exported data is delivered via ZoomVideoSDKDelegate::onWhiteboardExported:data:. Be sure to implement this callback in your delegate to handle the exported data.

Warning: During the export process (before receiving the ZoomVideoSDKDelegate::onWhiteboardExported:data: callback), calling stopShareWhiteboard will cause data loss. Wait until the export is complete before stopping the whiteboard share.

◆ isOtherSharingWhiteboard

- (BOOL) isOtherSharingWhiteboard

Checks whether another user is currently sharing a whiteboard.

Returns: true if another user is sharing whiteboard; otherwise it returns false.

◆ startShareWhiteboard

- (ZoomVideoSDKError) startShareWhiteboard

Starts whiteboard sharing in the session.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKErrors enum.

◆ stopShareWhiteboard

- (ZoomVideoSDKError) stopShareWhiteboard

Stops whiteboard sharing in the session.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKErrors enum.

◆ subscribeWhiteboard:

- (ZoomVideoSDKError) subscribeWhiteboard: (UIViewController *) vc

Displays the whiteboard view when someone is sharing the whiteboard.