Documentation
Collaborative Whiteboard
SDK downloads
Release notes

Release notes

Last updated：2022-03-22 13:07

Version 1.23.0

Release date: 2021-07-20

Enhancements

Enhancement	Description	Related API
Handwriting effect optimization	Optimized the handwriting effect to solve the problem that incoherent drawing points appear when drawing slowly.	-

Version 1.22.0

Release date: 2021-07-06

New features

New feature	Description	Related API
Handwriting effect	Added the support for handwriting effect, which enables users to draw with handwriting style strokes.	`enableHandwriting` `isHandwritingEnabled`

Enhancements

Enhancement	Description	Related API
SDK version verification	Throws out the error `3000007` during SDK initialization if the version of the ZegoWhiteboardView SDK doesn't match the version of the dependent ZEGO Express-Video SDK.	`ZegoWhiteboardViewErrorVersionMismatch`
SDK version verification	Throws out the error `3000008` during SDK initialization if the dependent Express-Video SDK doesn't have whiteboard support.	`ZegoWhiteboardViewErrorExpressImcompatible`

Version 1.21.0

Release date: 2021-05-31

New features

New feature	Description	Related API
Synchronization of whiteboard zooming	Added the support for sending and receiving whiteboard zooming information, so whiteboard zooming can be kept in sync across all participants.	`enableSyncScale` `enableResponseScale` `isEnableSyncScale` `isEnableResponseScale`

Enhancements

Enhancement	Description	Related API
Whiteboard name length limit	The length of whiteboard names is limited to a maximum of 128 bytes. The SDK throws out error `3020004` if a whiteboard name exceeds this limit.	`ZegoWhiteboardViewErrorViewNameLimit`
Accessibility check on the log directory and cache directory	During whiteboard initialization, perform accessibility check on the log directory and cache directory. If the log directory is not accessible, the SDK throws out error `3040010` . If the cache directory is not accessible, the SDK throws out error `3040011`.	`ZegoWhiteboardViewErrorLogPathNotAccess` `ZegoWhiteboardViewErrorCacheFolderNotAccess`
Login status check	When creating whiteboards, destroying whiteboards, or retrieving the whiteboard list, check whether the user has logged in, and throw out related errors if negative.	`ZegoWhiteboardViewErrorNoLoginRoom`
SDK log upload optimization	Use the SDK's default log path for log recording and uploading if it is not otherwise specified. We recommend you use the default setting.	-

Version 1.20.0

Release date: 2021-04-29

New features

New feature	Description	Related API
Support for HTML5 files	Added the support for using HTML5 files on the whiteboard.	-

Enhancements

Enhancement	Description	Related API
Adaptive image size	When adding an image, adjust the image size adaptively according to the width and height of the whiteboard.	-
Adaptive whiteboard size	When adding a whiteboard, adjust the whiteboard size adaptively according to the width and height of the parent container.	-
New error code `3020007`	The SDK throws out the error `3020007` when the animation information is too long.	-

Bug fixes

Fixed some issues that occasionally occur when switching between portrait and landscape screen orientation.
Fixed other known issues.

Version 1.19.0

Release date: 2021-03-25

New features

New feature	Description	Related API
Whiteboard permission control	Added the support for setting up permissions for various whiteboard operations, including scrolling, zooming in/out , creating graphic primitives, editing, moving, and deleting content.	For details, see the server API.
Setting whiteboard background image	Added the support for setting up a background image of whiteboards with configurable image filling modes.	`setBackgroundImage` `ZegoWhiteboardViewImageFitMode`
Removing whiteboard background image	Added the support for removing the whiteboard background image.	`clearBackgroundImage`
New callbacks to report whiteboard permission changes	Added a callback `onWhiteboardAuthChanged` to report changes on the permissions for whiteboard scrolling and zooming. Added a callback `onWhiteboardGraphicAuthChanged` to report changes on permissions for creating, editing, deleting, moving, and clearing whiteboard graphics primitives.	`onWhiteboardAuthChanged` `onWhiteboardGraphicAuthChanged`

Enhancements

Enhancement Description Related API

New error codes

Enhancement	Description	Related API
New error codes	Added the following error codes: `3050001`: No permission to zoom in/out on the whiteboard. `3050002`: No permission to scroll the whiteboard. `3050003`: No permission to create graphics primitives using gestures. `3050004`: No permission to edit graphics primitives created by others. `3050005`: No permission to move graphics primitives created by others. `3050006`: No permission to delete graphics primitives created by others. `3050007`: No permission to clear graphics primitives.	-
Optimization on the indication of graphics primitives bulk selection	When selecting multiple graphics primitives at a time, each selected graphics primitive is indicated separately with a rectangular frame, so that which graphics primitives are selected can be seen clearly and intuitively.	-

Added the following error codes:

3050001: No permission to zoom in/out on the whiteboard.
3050002: No permission to scroll the whiteboard.
3050003: No permission to create graphics primitives using gestures.
3050004: No permission to edit graphics primitives created by others.
3050005: No permission to move graphics primitives created by others.
3050006: No permission to delete graphics primitives created by others.
3050007: No permission to clear graphics primitives.

Optimization on the indication of graphics primitives bulk selection When selecting multiple graphics primitives at a time, each selected graphics primitive is indicated separately with a rectangular frame, so that which graphics primitives are selected can be seen clearly and intuitively. -

API changes

Deprecated APIs

Deprecated API	Description	To be deleted on
Deprecated API: `addTextEdit(Context context)` Replacement API: `addTextEdit(IZegoWhiteboardExecuteListener listener)`	On top of the original API, the new API validates the user's permission to perform the operation and returns the operation result. If the user attempts to add text without the permission to create graphics primitives, error `3050003` will be returned.	Version 1.22.0
Deprecated API: [`addText(String text, int positionX, int positionY)`] Replacement API: `addText(String text, int positionX, int positionY, IZegoWhiteboardExecuteListener listener)`	On top of the original API, the new API validates the user's permission to perform the operation and returns the operation result. If the user attempts to add text without the permission to create graphics primitives, error `3050003` will be returned.	Version 1.22.0
Deprecated API: [`clear()`] Replacement API: `clear(IZegoWhiteboardExecuteListener listener)`	On top of the original API, the new API validates the current user's permission to perform the operation and returns the operation result. If the user attempt to delete the selected graphics primitives without permission, error `3050006` will be returned.	Version 1.22.0
Deprecated API: [`clear(RectF rect)`] Replacement API: `clear(RectF rect,IZegoWhiteboardExecuteListener listener)`	On top of the original API, the new API validates the user's permission to perform the operation and returns the operation result. If the user attempt to clear all graphics primitives without permission, error `3050007` will be returned.	Version 1.22.0
Deprecated interface: [`deleteSelectedGraphics()`] Replacement API: `deleteSelectedGraphics(IZegoWhiteboardExecuteListener listener)`	On top of the original API, the new API validates the user's permission to perform the operation and returns the operation result. If the user attempt to delete the selected graphics primitives without permission, error `3050006` will be returned.	Version 1.22.0

Deleted APIs

Deleted API Description

Deleted API	Description
Deleted API: [`setCanDraw`] Replacement API: `setWhiteboardOperationMode`	-
Deleted API: [`enableUserOperation`] Replacement API: `setWhiteboardOperationMode`	-

Deleted API: [setCanDraw]

Replacement API: setWhiteboardOperationMode

Deleted API: [enableUserOperation]

Replacement API: setWhiteboardOperationMode

Version 1.18.0

Release date: 2021-03-04

New features

New feature	Description	Related API
Real-time stroke synchronization	When a user is drawing on the whiteboard, such as doodling or adding shapes (straight lines, rectangles, ellipses, circles), synchronize the stroke to all other participants in real time.	-

Enhancements

Enhancement	Description	Related API
Graphics primitives smoothness optimization	Optimized the smoothness of graphics primitives created by using the paintbrush.	-
Initialization process optimization	Added default log and cache file directories to simplify the initialization process.	-

Version 1.16.0

Release date: 2021-01-21

Bug fixes

Fixed known issues.

Version 1.15.0

Release date: 2021-01-07

New features

New Feature	Description	Related API
Adding images to the whiteboard	Added the support for adding images to the whiteboard. Like other ordinary graphics primitives, operations on the added images, including display, zooming, moving, and deletion, are synchronized across all participants.	`addImage`
Uploading custom image	Added the support for uploading network images using URLs, and other custom images. The uploaded custom image can be dragged onto the whiteboard using the custom image tool, and the operations on the custom images, including display, zooming, moving, and deletion, are synchronized across all participants.	`addImage` `ZegoWhiteboardViewToolCustomImage`
New whiteboard tool - custom image	Wit the custom image tool, users can drag the uploaded custom images onto the whiteboard.	`setToolType`
Setting whiteboard cache directory	Added the support for setting up the whiteboard cache directory.	`cacheFolder`
Clearing whiteboard cache	Added the support for clearing the whiteboard cache.	`clearCacheFolder`
New error codes	-	`ZegoWhiteboardViewError`

Version 1.14.0

Release date: 2020-12-24

New features

New feature	Description	Related API
Setting whiteboard operation mode	Added the support for setting up operation mode of the current whiteboard. The Whiteboard view object `ZegoWhiteboardView` has four basic operation modes, which can be used in combination.	`setWhiteboardOperationMode`

API changes

Deprecated API

Deprecated API Description Version to be Deleted

Deprecated API	Description	Version to be Deleted
Deprecated API: `canDraw` and `enableUserOperation` Replacement API: `setWhiteboardOperationMode`	The old APIs and the new APIs cannot be used together. Compared with the original APIs `canDraw` and `enableUserOperation`, the new API `setWhiteboardOperationMode` is more flexible and has a clearer setting of whiteboard operation permissions.	-

Deprecated API: canDraw and enableUserOperation

Replacement API: setWhiteboardOperationMode

The old APIs and the new APIs cannot be used together. Compared with the original APIs canDraw and enableUserOperation, the new API setWhiteboardOperationMode is more flexible and has a clearer setting of whiteboard operation permissions.

Version 1.13.0

Release date: 2020-12-07

New features

New feature	Description	Related API
Clearing a selected area of the whiteboard	Added the support for clearing all graphics primitives in the selected area of the whiteboard.	`clear(RectF rect)`

Bug fixes

Fixed the following issues:

The subscripts of the current page of the whiteboard are occasionally displayed inconsistently.
When adding text to the whiteboard, the text is not displayed in the correct position.

Version 1.12.0

Release date: 2020-11-19

New features

New feature	Description	Related API
Text input, permission control, and deletion of graphics primitives	Setting up default text for the text input box that pops up when users click the text tool. Adding text to the whiteboard. Permission control for various whiteboard opertions, including drawing, zooming in/out, and scrolling. Deleting the selected graphics primitives.	`setCustomText` `getCustomText` `addText` `enableUserOperation` `deleteSelectedGraphics`

Bug fixes

Fixed the issue that graphics primitives disappear after unlocking the screen on some models.

Version 1.11.0

Release date: 2020-11-02

New features

New feature	Description	Related API
Support for animated PPTs	Added the support for playing animations in powerpoint slides. The ZegoDocsView SDK is required for this feature.	ZegoWhiteboardView SDK: `playAnimation` ZegoWhiteboardView SDK: `setAnimationListener` ZegoDocsView SDK: `playAnimation` ZegoDocsView SDK: `setAnimationListener`
New whiteboard tool - Click	Added a value `ZegoWhiteboardViewToolClick = 0x100`to the enumeration `ZegoWhiteboardConstants` for the "click" operation. With this "click" operation, users can interact with animated PPTs, trigger the next animiation step, or turning to the next page.	`ZegoWhiteboardConstants`
New property `h5Extra` of the `ZegoWhiteboardViewModel` object	Added a new property `h5Extra` to the `ZegoWhiteboardViewModel` object. This property carries the PPT animation information that can be used to synchronize the playback of animations in PPTs.	`h5Extra`

Enhancements

Enhancement	Description	Related API
Paintbrush optimizations	Modified the default values of the paintbrush properties.	-

Bug fixes

Fixed the following issues:

Images are not displayed when the network connection resumes after being interrupted.
Audio and video are out of sync.
The laser pointer is not correctly displayed.
Error 60010 is reported when opening a document.

Version 1.10.0

Release date: 2020-09-28

Bug fixes

This version adds critical logs.

Version 1.9.0

Release date: 2020-09-07

New features

New feature	Description	Related API
Setting whiteboard log path	Added the support for setting whiteboard log path.	`setConfig`

Version 1.8.0

Release date: 2020-08-18

New features

New feature	Description	Related API
Text formatting options	Added two text formatting options: Bold and Italic.	`setFontBold` `setFontItalic`

Bug fixes

Fixed some issues with the laser pointer.