Collaborative Whiteboard
  • iOS
  • Android
  • Web : JavaScript
  • Electron
  • Windows
  • macOS
  • Overview
  • SDK downloads
  • Demo app
  • Sample codes
  • Development guide
  • Quick starts
  • Use cases
  • Error codes
  • Server APIs
  • 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. -

Bug fixes

Fixed the following issues:

  1. When zooming in/out on a whiteboard, entering text beyond the edge of the view would cause the peer whiteboards on the remote side to shift.
  2. When a user enters a room while others in the same room are drawing on the whiteboard, some graphics primitives created by other users are not synchronized.

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

Enhancements

Enhancement Description Related API
Error prompt optimization Optimized the prompt of the error that the physical size of the parent container is 0 when creating a whiteboard.

Bug fixes

Fixed the following issues:

  1. The content of the whiteboard is inconsistent with other participants in the room when the network connection resumes after being interrupted.
  2. The whiteboard background image is not displayed correctly for the users who enter the room later.
  3. The method attachView fails after the DOM of the whiteboard is deleted.
  4. When the whiteboard adapts to the size of the parent container, the coordinates of the graphics primitives are not adjusted correctly.
  5. When the whiteboard adapts to the size of the parent container, content on the scrollable whiteboard is not rendered correctly.
  6. Some primitives are occasionally lost when using handwriting input.

Version 1.21.2

Released date: 2021-06-10

Enhancements

Enhancement Description Related API
Optimization on SDK dependency Optimized the version dependency between the ZegoWhiteboardView SDK and the ZEGO Express-Video SDK. -

Bug fixes

Fixed the following issues:

  1. The whiteboard disappears after re-rendering it by calling the reloadView method.
  2. Graphics primitives on the whiteboard shift after re-rendering the whiteboard at a page other than the first page by calling the reloadView method.

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.

Enhancements

Enhancements 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
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.

Bug fixes

Fixed the issue that the last line of the text is not displayed when the text primitives are edited by other participants.

Version 1.20.0

Release date: 2021-04-29

New features

New feature Description Related API
Adaptive whiteboard size When the size of the parent container changes, re-render the whiteboard by calling the reloadView method to adapt the whiteboard to the new size of the parent container. reloadView
Support for HTML5 files Added the support for using HTML5 files on the whiteboard. -

Enhancements

Enhancement Description Related API
Optimization on the strategy in receiving graphics primitives Optimize the strategy of pulling a large number of primitives in batch. -
Paintbrush drawing optimization Interrupt the drawing when the size of the graphics primitive exceeds the limit. -
Callback optimization Optimized the timing of the viewScroll callback. viewScroll
Adaptive image size When adding an image, adjust the image size adaptively according to the width and height of the whiteboard. -
New error code 3020007 The SDK throws out the error 3020007 when the animation information is too long. -

Bug fixes

Fixed the following issues:

  1. When destroying the designated whiteboard, occasionally other whiteboards are also destroyed.
  2. When the whiteboard name is too long, the error code is not correctly returned.
  3. No error code is returned when the number of animations in an animated PPT exceeds the limit.
  4. Stutters in drawing when multiple participants are drawing at the same time.

Version 1.19.1

Release date: 2021-04-15

Enhancements

Enhancement Description Related API
Optimization on SDK dependency Optimized the version dependency between the ZegoWhiteboardView SDK and the ZEGO Express-Video SDK. -

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 server APIs.
Setting whiteboard background image Added the support for setting up a background image of whiteboards with configurable image filling modes.
Removing whiteboard background image Added the support for removing the whiteboard background image. clearBackgroundImage
New callbacks to report whiteboard permission changes

Added a callback whiteboardAuthChange to report changes on the permissions for whiteboard scrolling and zooming.

Added a callback whiteboardGraphicAuthChange to report changes on permissions for creating, editing, deleting, moving, and clearing whiteboard graphics primitives.

Enhancements

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. -

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
Feature optimization Optimized the undo and redo features. -

Bug fixes

Fixed the following issues:

  1. When users who join the room later click on an animated PPT, the current animation step goes back.
  2. Users who join the room later can't operate cross-page primitives.
  3. Position shift of the laser pointer.
  4. Issues with simultaneous operations of scrolling, page turning, and drawing.
  5. Other known issues.

API changes

  • Deprecated APIs
Deprecated API Description To be deleted on

Deprecated API: enable and enableUserOperation

Replacement API: setWhiteboardOperationMode

- Version 1.18

Deprecated API: isEnable

- Version 1.18

Deprecated API: getPage

Replacement API: getCurrentPage

- Version 1.18

Version 1.17.0

Release date: 2021-02-04

New features

New feature Description Related API
Whiteboard snapshot

Saves the current page content of the whiteboard as an image, including all graphics primitives, shapes, images, background color, and others.

Added a new method snapshot to obtain the base64 data of the whiteboard snapshot, which then can be converted into a picture.

snapshot
Support for touch screens Added the support for touch screens. -

Bug fixes

Fixed the following issues:

  1. After zooming in on a whiteboard and switching it repeatedly, the whiteboard "jumps" when it is dragged.

  2. Custom images and shapes cannot be displayed on iOS 11.

Version 1.16.0

Release date: 2021-01-21

Enhancements

Enhancement Description Related API
Process optimization Optimized the interaction process of deleting primitives with the eraser. -
Process optimization Optimized the interaction process of selecting primitives. -

Bug fixes

Fixed the issue that the position of graphics primitives is not synchronized in some scenarios of undo and redo.

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
Custom image upload 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
  • ZegoWhitebaordViewToolCustomImage
New whiteboard tool - custom image Wit the custom image tool, users can drag the uploaded custom images onto the whiteboard. setToolType
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
Setting deferred rendering Added the support for setting up the delay time for the deferred rendering of the whiteboard. setDeferredRenderingTime
New error codes - ZegoWhiteboardError

Version 1.14.0

Release date: 2020-12-24

Enhancements

Enhancement Description Related API
Log optimization Optimized internal log reporting and added more detailed logs. -
Optimization on the graphical primitives clearing method Optimized the method of clearing graphical primitives from the current page, with quick locating of graphical primitives to be deleted. -

Bug fixes

Fixed the following issues:

  1. The animation step of a single-page animated PPT are not synchronized across multiple participants.
  2. Cannot draw on a single-page whiteboard that is zoomed in/out.
  3. Text auto line wrapping doesn't work correctly at the border of the whiteboard.
  4. Exceptions in clearing the cross-page graphics primitives from the current page.
  5. After switching from an animated PPT to another whiteboard and then switching back, the drawing tools don't work and the animation step is out of sync.

Version 1.13.0

Release date: 2020-12-07

New features

New feature Description Related API
Clearing the current page of the whiteboard Added the support for clearing all graphics primitives in curent page of the whiteboard. clearCurrentPage

Enhancements

Enhancement Description Related API
Data transmission limit When the size of the graphics primitive being operated on exceeds the data transmission volume limit (5 KB), an error will be thrown out through a global error callback. -
Optimization on type declarations Simplified SDK-related type declarations. -
Optimization on file scrolling Optimized the synchronization of internal file scrolling. -

Bug fixes

Fixed the following issues:

  1. If the name of the whiteboard is too long, the whiteboard is not created correctly.
  2. When the Italic font formatting option is selected, the text on the right side of the input box is not fully displayed.
  3. Scrolling on long files is not correctly synchronized.
  4. The scrolling information of the remote whiteboard is lost when the whiteboard rendering is not yet completed.

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
  • Adding text to the whiteboard.
  • Permission control for various whiteboard opertions, including drawing, zooming in/out, and scrolling.
  • Deleting the selected graphics primitives.

Bug fixes

Fixed the following issues:

  1. Straight lines that are vertical or horizontal to the border of the browser cannot be bulk selected.
  2. When a text is being edited, other text cannot be dragged.

Version 1.11.0

Release date: 2020-11-02

New features

New feature Description Related API
New whiteboard tool - Click Added a new whiteboard tool type ZegoWhiteboardViewToolClick, which can be used to interact with animated PPTs, triggering the next animiation step or turning to the next page. setToolType

Bug fixes

Fixed text display issues.

Version 1.10.0

Release date: 2020-09-28

Enhancements

Enhancement Description Related API
Optimization on whiteboard zooming permission control Optimized the whiteboard zooming permission control. Users who have no whiteboard zooming permission can only drag and drop on the current whiteboard view. -

Bug fixes

Fixed the following issues:

  1. Issues related to text primitives.
  2. Issues related to undo and redo.

Version 1.9.0

Release date: 2020-09-07

New features

New feature Description Related API
Logging Added local logging and log reporting features. -

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.

Bug fixes

Fixed some issues with the laser pointer.

Page Directory