Documentation
Collaborative Whiteboard
Function Overview

Function Overview

Last updated：2023-03-14 16:55

ZEGO Express SDKs provide rich APIs for you to quickly build audio/video calling and live streaming capabilities into your applications based on ZEGO's cloud live streaming platform. With a powerful audio/video processing engine and a global real-time network, the platform is providing high-quality and reliable cloud audio/video streaming services to businesses around the world.

ZEGO Express SDKs are available for all major platforms, including Android, iOS, Mac, Windows, and Web.

SDK Initialization

Method	Description
clearCacheFolder	Clear the entire cache directory
getVersion	Get the SDK version number
clear	Clean up resources before logout of a room
init	Initialize ZegoWhiteboardView SDK
uninit	Uninitialize the SDK
setConfig	Set whiteboard configuration information

Whiteboard Creation and Destroy

Method	Description
createWhiteboardView	Create a ZegoWhiteboardView
destroyWhiteboardView	Destroy specified ZegoWhiteboardView
getWhiteboardViewList	Get ZegoWhiteboardView list
setWhiteboardManagerListener	Set up the monitor for adding and deleting whiteboard related errors
getWhiteboardViewModel	Get the ZegoWhiteboardViewModel associated with the current whiteboard

Whiteboard Manipulation (paging, zooming, scrolling, drawing)

Method	Description
enableHandwriting	Set whether to open the pen sharp
enableResponseScale	Whether to respond to the zoom of other members in the room
enableSyncScale	set Whether to synchronize the zoom to other members in the room
getCustomText	Get the default text of the text teaching aid
setCustomText	Set the default text of text teaching aids
isEnableResponseScale	Get whether to respond to the zoom synchronization message of other members in the room
isEnableSyncScale	Get whether the zoom is currently synchronized to other members in the room
isHandwritingEnabled	Get whether the handwriting effect is enabled
setScrollListener	Set callback monitoring for whiteboard scrolling
scrollTo	Scroll the whiteboard to the specified offset position, described in percentage
undo	Undo the last drawing
redo	Restore the operation undone in the previous step
clear	Clear all primitives on the whiteboard
addText	Add custom text to the whiteboard
addTextEdit	Add text to the whiteboard View, and an input box will pop up from the bottom of the whiteboard after calling.
setVisibleRegion	Set the size of the visible area, when used with DocsView.
getVerticalPercent	Get the current vertical scroll percentage of Whiteboard View
getHorizontalPercent	Get the current horizontal scroll percentage of Whiteboard View
getScaleFactor	Get the current zoom ratio
getScaleOffsetX	Get current zoom X axis offset
getScaleOffsetY	Get current zoom Y axis direction offset
setScaleListener	Set whiteboard zoom callback
playAnimation	Synchronize dynamic PPT to play animation information to other terminals
setAnimationListener	Set up animation monitoring for dynamic PPT
deleteSelectedGraphics	Delete selected graphics
setWhiteboardOperationMode	Set the operation mode of the current whiteboard, see ZegoWhiteboardOperationMode for more details.
addImage	Add pictures to the whiteboard
setBackgroundImage	Set a background image to the whiteboard
clearBackgroundImage	Remove background image of the whiteboard
canDraw	Determine whether the whiteboard allows drawing
enableUserOperation	Whether to allow users to operate the whiteboard

Select the Function of the Brush Tool

Method	Description
enableCustomCursor
enableRemoteCursorVisible	Set whether to enable the display of remote custom cursor
getBrushColor	Get brush color
getBrushSize	Get brush thickness
setToolType	Set the current whiteboard operation tool (teaching aid)
getToolType	Get the whiteboard operation tool (teaching aid) you are using
setBrushColor	Set brush color
setBrushSize	Set the brush thickness
setFontSize	Set text size
setFontBold	Set text bold
isFontBold	Get whether the text is bold
getFontSize	Get text size
setFontItalic	Set text italic
isFontItalic	Get whether the text is italic
setCustomFontFromAsset	Set custom font source file path