IZoomVideoSDKWhiteboardHelper Class Reference

The whiteboard helper interface. More...

#include <zoom_video_sdk_whiteboard_helper_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	subscribeWhiteboard (void *hOwner)=0
	Displays the whiteboard view when someone is sharing the whiteboard.
virtual ZoomVideoSDKErrors	unSubscribeWhiteboard ()=0
	Hides the whiteboard sharing view when someone is sharing the whiteboard.
virtual bool	canStartShareWhiteboard ()=0
	Checks whether the current user can start whiteboard sharing. Only the host can start whiteboard sharing.
virtual bool	canStopShareWhiteboard ()=0
	Checks whether the current user can stop whiteboard sharing.
virtual ZoomVideoSDKErrors	startShareWhiteboard ()=0
	Starts whiteboard sharing in the session.
virtual ZoomVideoSDKErrors	stopShareWhiteboard ()=0
	Stops whiteboard sharing in the session.
virtual bool	isOtherSharingWhiteboard ()=0
	Checks whether another user is currently sharing a whiteboard.
virtual ZoomVideoSDKErrors	exportWhiteboard (ZoomVideoSDKExportFormat format)=0
	Exports the currently shared whiteboard.
virtual ZoomVideoSDKErrors	setCustomizedResIcon (void *hResInstance, unsigned int iconID)=0
	Sets a custom icon for the whiteboard sharing content window.

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 IZoomVideoSDK::leaveSession)
• Joining a sub-session (calling ISubSessionKit::joinSubSession or ISubSessionKit::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 20 of file zoom_video_sdk_whiteboard_helper_interface.h.

Member Function Documentation

canStartShareWhiteboard()

virtual bool IZoomVideoSDKWhiteboardHelper::canStartShareWhiteboard ( )

pure virtual

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.

canStopShareWhiteboard()

virtual bool IZoomVideoSDKWhiteboardHelper::canStopShareWhiteboard ( )

pure virtual

Checks whether the current user can stop whiteboard sharing.

Returns

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

exportWhiteboard()

virtual ZoomVideoSDKErrors IZoomVideoSDKWhiteboardHelper::exportWhiteboard ( ZoomVideoSDKExportFormat format )

pure virtual

Exports the currently shared whiteboard.

Parameters

format

The export format.

Returns

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

Note

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

Warning

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

isOtherSharingWhiteboard()

virtual bool IZoomVideoSDKWhiteboardHelper::isOtherSharingWhiteboard ( )

pure virtual

Checks whether another user is currently sharing a whiteboard.

Returns

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

setCustomizedResIcon()

virtual ZoomVideoSDKErrors IZoomVideoSDKWhiteboardHelper::setCustomizedResIcon ( void * hResInstance, unsigned int iconID )

pure virtual

Sets a custom icon for the whiteboard sharing content window.

Parameters

hResInstance	A handle to the module that contains the icon resource.
iconID	The resource ID of the icon to used.

Returns

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

Note

This function should be called before joining a session if you want to use a custom icon.

startShareWhiteboard()

virtual ZoomVideoSDKErrors IZoomVideoSDKWhiteboardHelper::startShareWhiteboard ( )

pure virtual

Starts whiteboard sharing in the session.

Returns

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

stopShareWhiteboard()

virtual ZoomVideoSDKErrors IZoomVideoSDKWhiteboardHelper::stopShareWhiteboard ( )

pure virtual

Stops whiteboard sharing in the session.

Returns

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

subscribeWhiteboard()

virtual ZoomVideoSDKErrors IZoomVideoSDKWhiteboardHelper::subscribeWhiteboard ( void * hOwner )

pure virtual

Displays the whiteboard view when someone is sharing the whiteboard.

Parameters

hOwner

Specify the owner window handle. If the hOwner is nullptr, the owner window will be desktop window.

Returns

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

Note

The whiteboard view should be hidden when whiteboard sharing is stopped, or the user who is sharing the whiteboard leaves session, or the session is failover for Errors_Session_Reconncting.

unSubscribeWhiteboard()

virtual ZoomVideoSDKErrors IZoomVideoSDKWhiteboardHelper::unSubscribeWhiteboard ( )

pure virtual

Hides the whiteboard sharing view when someone is sharing the whiteboard.

Returns

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