This page provides the release notes for the Agora Interactive Whiteboard SDK.
v2.15.16 was released on January 21, 2022.
This release provides the following improvements:
disconnect
and setWritable
to ensure that the SDK returns a Promise
object only when all requests sent before the disconnect()
or setWritable(false)
method call are executed.floatBar
), and saves the text format set by users on the floating bar.This release fixed the following issues:
room.state.memberState
returned the initial state of the room, rather than the current state.room.state.memberState
occasionally returned undefined
.floatBar
) sometimes did not work or disappeared.dispatchMagixEvent
to send an event.canvas
rendering engine occasionally crashed.canvas
rendering was occasionally high.v2.15.1 was released on November 16, 2021, which fixed the following issues with displaying dynamic PPT files in the whiteboard:
v2.15.2 was released on November 19, 2021.
1. Disables/Enables the frequency limit for writing synchronization
This release adds the disablePencilWrittingLimitFrequency
property in JoinRoomParams
, for disabling or enabling the frequency limit for synchronizing the writing input while using the pencil
tool.
2. Options for setting a custom event listener
This release adds the options
parameter in addMagixEventListener
as well as the MagixEventListenerOptions
type, for setting the following options for a custom event listener:
fireInterval
: The interval (ms) of the SDK triggering custom event callbacks.fireSelfEventAfterCommit
: Whether to send event callbacks after the Agora server acknowledges the dispatchMagixEvent
method call is successful.This release fixed the rendering crashes after initializing the room or adjusting the order of components in the scene under certain circumstances.
Added
disablePencilWrittingLimitFrequency
property in JoinRoomParams
options
parameter in addMagixEventListener
MagixEventListenerOptions
v2.15.0 was released on November 16, 2021.
To help you manage users in a room, this release adds the uid
property in JoinRoomParams
, for setting the unique identifier of a user.
If you upgrade the SDK to v2.15.0 or later, to avoid affecting your service, ensure that you pass in a string uid
in JoinRoomParams
when calling joinRoom
. The uid
of each user cannot be longer than 1024 bytes and must be unique in the same room. For more information, see Join a Whiteboard Room.
1. Disables/Enables the frequency limit for sending custom events
This release adds the disableMagixEventDispatchLimit
property in JoinRoomParams
, for disabling or enabling the frequency limit for sending custom events.
2. File conversion optimizations
This release adds support for converting and displaying the following PowerPoint (PPT) features:
This release provides the following improvements:
uniformScale
in ImageInformation
as true
by default when the insertImage
method is called. This ensures the image is scaled based on its original aspect ratio when a user adjusts its size. If you do not want the image to be scaled proportionately, you can set uniformScale
as false
.This release has fixed the following issues:
setWritable(false)
at the time of joining the room.room.state.roomMembers
.Added
The following properties in JoinRoomParams
:
uid
disableMagixEventDispatchLimit
Modified
Deleted
pencilOptions
property in MemberState
broadcasterInformation
property in BroadcastState
zoomScale
property in RoomState
scheduleTime
property in Player
seekToScheduleTime
method in Player
v2.14.5 was released on November 10, 2021.
As of this release, white-web-sdk
no longer supports the following versions of mobile browsers:
1. Importing and exporting scenes
This release adds the following methods for importing and exporting scenes:
exportScene
: Exports all the contents of a specified scene, including the image or web page displayed on the scene, and saves them as a binary file (Blob object).importScene
: Imports the contents of a scene exported by using exportScene
into a specified scene directory.2. Scene path type
This release adds the conflict
enumerator in ScenePathType
, which indicates that a path cannot exist because it contains the path of an existing scene.
3. Locking images
To support locking or unlocking selected images, this release adds the lockImages
method. When an image is locked, the user cannot move, zoom, or delete the image.
4. Adjusting font size
This release adds the updateTextFontSize
method for adjusting the size of the text entered with the text
tool.
5. Adjusting component layers
To support adjusting the layers of components, this release adds the following methods:
moveSelectedComponentsToTop
: Moves the selected components to the top layer.moveSelectedComponentsToBottom
: Moves the selected components to the bottom layer.This release provides the following improvements:
ArrayBuffer
payload between users with the Web SDK.onPhaseChanged
callback.This release has fixed the following issues:
customInput
method call did not take effect.InvisiblePlugin
, the new attributes
could not be the same as the original attributes
.Added
exportScene
importScene
conflict
in ScenePathType
lockImages
updateTextFontSize
moveSelectedComponentsToTop
moveSelectedComponentsToBottom
v2.13.17 was released on August 20, 2021.
To improve the dynamic file conversion function, this release adds support for converting and displaying the following PowerPoint (PPT) features:
This release has the following improvements:
This release fixed the following issues:
CameraBound
.follower
view mode, the center point of the view was slightly shifted.pptPreviousStep
to roll back a slide.v2.13.11 was released on July 23 2021.
To improve the dynamic file conversion function, this release adds support for converting and displaying the following PowerPoint (PPT) features:
This release has the following improvements:
previewURL
parameter in PptDescription
, which supports displaying dynamic PPT previews in the whiteboard.This release fixed the following issues:
v2.13.4 was released on June 15, 2021.
This release fixed the issue that calling the moveCamera
method did not take effect.
v2.13.2 was released on June 10, 2021.
This release fixed the following issues:
redo
and undo
methods.v2.12.21 was released on June 4, 2021.
This release fixed the following issues:
tablestyle.xml
file could not be parsed.v2.12.20 was released on May 24, 2021.
This release optimizes the log levels for dynamic PPT files.
v2.12.19 was released on May 20, 2021.
This release fixed the issue that in certain circumstances, the SDK failed to connect to the server and returned the error message magix connect failed
.
v2.12.18 was released on May 17, 2021.
This release enables server-side typesetting (useServerWrap
) by default and supports reducing the size of font files for fasterer rendering.
v2.12.17 was released on May 13, 2021.
This release fixed the issue that inaccurate system time on the user's device caused an abnormal delay in a live Interactive Whiteboard room.
v2.12.16 was released on May 11, 2021.
This release adds the following features:
This release fixed the following issues:
selectable
field did not take effect when calling room.insertPlugin
.v2.12.15 was released on April 28, 2021.
This release adds changeToClick
and changeToText
, which set the shortcut to quickly switch to the clicker tool (clicker
) and text tool (text
), respectively.
This release improves the loading speed of dynamic PPT files.
v2.12.14 was released on April 22, 2021.
This release adds audio and video trimming.
This release improves the logic of preloading dynamic PPT files.
This release fixed the following issues:
room.state.cameraState
was not updated in a timely manner in some cases.v2.12.13 was released on April 21, 2021.
This release fixed the issue that a delay might occur when the text box entered or exited editing mode in some cases.
v2.12.12 was released on April 16, 2021.
This release has the following improvements:
v2.12.11 was released on April 15, 2021.
This release adds the following features:
syncBlockTimstamp
method to set the delay time for sending the whiteboard contents. This method is used to ensure that the whiteboard content and the audio and video are sent to the remote users at the same time.customInput
interface for setting custom inputs.This release improves the display performance of canvas
mode.
This release fixed the following issues:
InvisiblePlugin
had abnormal behavior in some cases.v2.12.9 was released on April 9, 2021.
This release fixed the following issues:
canvas
rendering engine rendered images inaccurately in certain older versions of browsers.v2.12.8 was released on March 30, 2021.
This version improves the logic of reporting logs.
This release fixed the problem that setting follower mode did not take effect immediately.
v2.12.6 was released on March 29, 2021. This release fixed the issue that some components could disappear unexpectedly.
v2.12.5 was released on March 20, 2021.
This release adds the stroke effect to better display handwriting. When constructing joinRoomParams
, you can set disableNewPencil
to false
/true
to enable/disable the stroke effect.
This release improves the Text tool.
This release fixed the following issues:
Symbol
objects displayed abnormal actions when using the whiteboard on browsers that support ES6.v2.12.2 was released on March 4, 2021. This release improves network connection.
v2.12.1 was released on March 4, 2021. This release fixed the issue that onPPTLoadProgress
reported inaccurate progress of file-conversion tasks.
v2.12.0 was released on February 26, 2021.
This release adds the following features:
To provide more drawing options, ShapeType
adds the following enumeration values:
triangle
: Inserts a trianglerhombus
: Inserts a diamond shapepentagram
: Inserts a pentagramspeechBalloon
: Inserts a speech balloonThe floating bar adds a Layer button to send an image to the front or back of the layer stack.
The floating bar adds a Replicate button.
disableOthersSelectingBox
is added to Displayer
and JoinRoomParams
to set whether to hide or show other users' selection fields.
uniformScale
is added to ImageInformation
to resize images proportionately.
The server-side engine can be used for typesetting.
This release fixed the following issues: