Documentation
Collaborative Whiteboard
Function Overview

Function Overview

Last updated：2021-07-06 22:44

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
getVersion	Get the SDK version number
clear	Clean up resources before logout of a room

Whiteboard Creation and Destroy

Method	Description
createView	Create a ZegoWhiteboardView
destroyView	Destroy specified ZegoWhiteboardView
attachView	Add ZegoWhiteboardView to view
getViewList	Get ZegoWhiteboardView list
on	Register to listen for events
off	Delete listening event

Whiteboard Manipulation (paging, zooming, scrolling, drawing)

Method	Description
getAspectRatio	Get ZegoWhiteboardView aspect ratio
getBackgroundColor	Get the ZegoWhiteboardView background color
setBackgroundColor	Set the ZegoWhiteboardView background color
getCreateTime	Get the ZegoWhiteboardView creation time
getCurrentScrollPercent	Get scroll percentage
getFileInfo	Get the file information associated with this ZegoWhiteboardView
setScaleFactor	Zoom ZegoWhiteboardView
getScaleFactor	Get the current zoom ratio
getHorizontalPercent	Get the current horizontal scroll percentage of the ZegoWhiteboardView
getID	Get ZegoWhiteboardView ID
getName	Get the name of the ZegoWhiteboardView
getCurrentPage	Get the current page number of the ZegoWhiteboardView, starting from 1
getPageCount	Get the number of ZogoWhiteboardView pages
getRoomID	Get the current room ID
getScaleOffsetX	Get current zoom X axis offset
getScaleOffsetY	Get current zoom Y axis direction offset
getVerticalPercent	Get the current vertical scroll percentage of ZogoWhiteboardView
isFontBold	Get whether the text is bold
isFontItalic	Get whether the text is italic
redo	Restore the operation undone in the previous step
scroll	Scroll the whiteboard to the specified offset position, described by percentage, the value range is 0~1.0
undo	Undo the last drawing
deleteSelectedGraphics	Delete selected graphics
clearCurrentPage	Clear the current page primitives
addImage	Add a picture in the ZogoWhiteboardView.
setWhiteboardOperationMode	Set the operating mode of the current ZegoWhiteboardView, see ZegoWhiteboardOperationMode for details.
snapshot	Get a snapshot of the current whiteboard.
setBackgroundImage	Set the whiteboard background image
clear	Clear all primitives on the ZegoWhiteboardView
reloadView	Reload the whiteboard View
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

Select the Function of the Brush Tool

Method	Description
getBrushColor	Get brush color
setBrushColor	Set brush color
getBrushSize	Get brush thickness
setBrushSize	Set the brush thickness
setTextSize	Set text size
setFontBold	Set text bold
setFontItalic	Set text italic
setToolType	Set the ZegoWhiteboardView tool type
addText	Add text in ZegoWhiteboardView