本文提供声网互动白板 SDK 的发版说明。
该版本于 2022 年 12 月 2 日发布。
1. 教具新特性
该版本为以下白板教具添加了新特性:
alt/option
键可以以光标为圆心画圆。shift
键可以画直线。room.memberState
中添加 dottedLine: true
以开启该功能。NewPencilWritingQuality
调整书写性能与书写质量之间的平衡。room.memberState
中添加 textCanSelectText: true
以开启该功能。此外,该版本还新增了铅笔橡皮工具,用于擦除局部铅笔笔迹。
2. 白板截图
该版本新增 screenshotToCanvas
方法,可以将指定白板内容截图至 canvas。
该版本修复了如下问题:
room.setMemberState()
中的某些字段无法保存到本地。floatBar
)在部分触摸设备上无法正常使用。新增
MemberState
新增属性 dottedLine
和 textCanSelectText
NewPencilWritingQuality
screenshotToCanvas
ApplianceNames
新增枚举值 pencilEraser
该版本于 2022 年 7 月 8 日发布。
1. 文字编辑
为支持自定义文本编辑选项,该版本新增如下 API:
insertText
:在指定位置插入文字。updateText
:修改指定文字的内容。updateSelectedText
:修改当前被选中文字的字体样式,包括字体大小、颜色、是否加粗、是否斜体等。你可以使用上述 API 自定义文本输入框和编辑工具栏。
同时,该版本在 MemberState
中新增 textColor
、bold
、italic
、underline
和 lineThrough
属性,提供更加丰富的文本编辑选项。当你使用白板 SDK 提供的 text
工具,但想自定义文本编辑工具栏时,你可以将 JoinRoomParams
中的 floatBar
属性设为 false
,并通过 MemberState
中新增的属性编辑文本。
此外,该版本删除了 updateTextFontSize
方法,你可以使用 updateSelectedText
或 MemberState
中的 textSize
代替。
2. 图片旋转
该版本在 WhiteWebSdkConfiguration
中新增 disableRotation
属性,用于开启或关闭图片旋转功能。SDK 默认开启图片旋转。开启该功能后,用户可以任意旋转选中的图片。如果需要关闭,可以设置 disableRotation(true)
。
3. 补间动画
该版本为铅笔工具新增补间动画功能。当用户使用铅笔书写时,SDK 会自动在关键帧之间插入帧,使远端用户看到的笔迹绘制过程更加流畅,但会因此增加延时。
同时,该版本在 WhiteWebSdkConfiguration
中新增 disableCurveAnimes
属性,用于开启或关闭新铅笔的补间动画功能。SDK 默认开启补间动画功能。如果需要关闭,可以设置 disableCurveAnimes(true)
。
disableNewPencil
设为 fasle
时生效。4. 关闭笔锋效果
该版本在 WhiteWebSdkConfiguration
中新增 disableNewPencilStroke
属性,用于开启或关闭铅笔的笔锋效果。disableNewPencilStroke
默认值为 true
,当你设置 disableNewPencil(false)
开启新铅笔后,SDK 立即开启笔锋效果。如果需要关闭新铅笔的笔锋效果,可以设置 disableNewPencilStroke(true)
。
disableNewPencil
设为 fasle
时生效。5. 获取场景信息
该版本在 Displayer
类中新增 getScene
方法,支持使用场景路径获取指定场景的信息。
6. 场景回调
该版本新增 createScenesCallback
方法,用于创建场景目录的监听器对象。成功创建监听器对象后,当指定场景目录下的场景、子场景目录发生变化时,SDK 会触发你在 ScenesCallbacks
中注册的回调,报告场景事件。
7. 动态 PPT 中的媒体文件播放出错回调
该版本新增 onPPTMediaPlayError
回调,用于报告动态 PPT 中的媒体文件播放时发生的异常。
该版本进行了如下改进:
该版本修复了如下问题:
setWritable
时可能会发生错误。新增
insertText
updateText
updateSelectedText
getScene
createScenesCallback
onPPTMediaPlayError
MemberState
中新增如下属性:textColor
bold
italic
underline
lineThrough
WhiteWebSdkConfiguration
中新增如下属性:disableRotation
disableCurveAnimes
disableNewPencilStroke
删除
updateTextFontSize
CustomInput
该版本于 2022 年 1 月 21 日发布。
该版本进行了如下改进:
disconnect
和 setWritable
的逻辑。当调用 disconnect
或 setWritable(false)
时,待调用该方法之前所有请求都执行完成后才令 Promise 成功。floatBar
)的 UI,并保存用户通过浮动条设置的字体样式。该版本修复了如下问题:
room.state.memberState
为房间初始化时的状态,而非当前的状态。room.state.memberState
为 undefined
。floatBar
)的按钮不起作用或直接消失。dispatchMagixEvent
发送事件后多次收到事件回调。canvas
渲染崩溃。canvas
渲染占用内存过高。该版本于 2021 年 11 月 16 日发布,修复了在白板中展示动态 PPT 时遇到的如下问题:
该版本于 2021 年 11 月 19 日发布。
1. 关闭/开启笔迹同步的频率限制
该版本在 JoinRoomParams
中新增 disablePencilWrittingLimitFrequency
属性,支持关闭或开启在使用 pencil
书写时笔迹同步的频率限制。
2. 自定义事件监听选项
为方便开发者灵活监听自定义事件,该版本在 addMagixEventListener
方法中新增 options
参数并新增 MagixEventListenerOptions
类,支持设置以下自定义事件监听选项:
fireInterval
:SDK 触发自定义事件回调的间隔,单位为毫秒。fireSelfEventAfterCommit
:是否待服务器确认 dispatchMagixEvent
方法调用成功后再发送事件回调。该版本修复了特定情况下,房间初始化或调整场景中组件顺序后渲染崩溃的问题。
新增
JoinRoomParams
中新增 disablePencilWrittingLimitFrequency
属性addMagixEventListener
中新增 options
参数MagixEventListenerOptions
该版本于 2021 年 11 月 16 日发布。
为方便管理房间内的用户,该版本在 JoinRoomParams
中新增 uid
属性,用于设置用户的唯一标识符(UID)。
如果你将 SDK 升级到 v2.15.0 或之后版本,为保证你的业务功能不受影响,调用 joinRoom
时必须在 JoinRoomParams
传入字符串格式的 uid
,长度不超过 1024 字节,并确保同一房间内每个用户的 uid
唯一。详见《加入实时房间》
1. 关闭/开启发送自定义事件的频率限制
该版本在 JoinRoomParams
中新增 disableMagixEventDispatchLimit
属性,支持关闭或开启发送自定义事件的频率限制。
2. 文档转换优化
该版本新增支持转换和展示如下 PowerPoint(PPT)特性:
1. 跳转回放
为方便获取跳转操作的结果,该版本将 seekToProgressTime
方法的返回值由 void
改为 Promise
。成功调用 seekToProgressTime
方法后,SDK 会返回 PlayerSeekingResult
,报告跳转回放的结果。
2. 其他改进
该版本进行了如下改进:
insertImage
插入图片时,SDK 默认将 ImageInformation
中的 uniformScale
设为 true
,确保用户调整图片时,图片会按比例缩放。如果你不需要图片按比例缩放,可以将 uniformScale
设为 false
.该版本修复了如下问题:
setWritable(false)
导致房间状态异常。room.state.roomMembers
时,每个字段可能出现两次。新增
JoinRoomParams
中新增以下属性:
uid
disableMagixEventDispatchLimit
修改
删除
MemberState
中的 pencilOptions
属性BroadcastState
中的 broadcasterInformation
属性RoomState
中的 zoomScale
属性Player
中的 scheduleTime
属性Player
中的 seekToScheduleTime
方法该版本于 2021 年 10 月 21 日发布。
自该版本起,white-web-sdk
不再支持以下版本的移动端浏览器:
1. 导入导出场景
该版本新增如下方法支持导入和导出场景:
exportScene
:导出指定场景的所有内容,包括场景中展示的图片或网页,并保存为二进制文件(Blob 对象)。importScene
:将通过 exportScene
方法导出的场景内容导入指定的场景目录中。2. 场景路径类型
该版本在 ScenePathType
中新增 conflict
枚举,表示该路径中包含已有场景的路径,无法存在。
3. 锁定图片
该版本新增 lockImages
方法,支持锁定或解除锁定选中的图片。当图片被锁定时,用户无法移动、缩放或删除该图片。
4. 调整字体大小
该版本新增 updateTextFontSize
方法,用于调整使用 text
工具输入的文字的大小。
5. 调整组件层级
该版本新增如下方法,支持调整组件层级:
moveSelectedComponentsToTop
:移动选中的组件到顶层。moveSelectedComponentsToBottom
:移动选中的组件到底层。该版本进行了如下改进:
payload
为 ArrayBuffer
的自定义事件。onPhaseChanged
回调的准确性。该版本修复了如下问题:
customInput
自定义输入源不生效。InvisiblePlugin
时,新传入的 attributes
无法与原 attributes
重复。新增
exportScene
importScene
ScenePathType
中新增 conflict
lockImages
updateTextFontSize
moveSelectedComponentsToTop
moveSelectedComponentsToBottom
该版本于 2021 年 8 月 20 日发布。
为完善动态文档转换功能,该版本新增支持转换和展示如下 PowerPoint 特性:
该版本进行了如下优化:
该版本修复了如下问题:
connecting
状态。该版本于 2021 年 7 月 23 日发布。
为完善动态文档转换功能,该版本新增支持转换和展示如下 PowerPoint(PPT)特性:
该版本进行了如下优化:
PptDescription
中新增 previewURL
参数,支持在白板场景中展示动态 PPT 预览图。该版本修复了如下问题:
该版本于 2021 年 6 月 15 日发布。
该版本修复了调用 moveCamera
不生效的问题。
该版本于 2021 年 6 月 10 日发布。
该版本修复了如下问题:
redo
、undo
方法的部分异常行为。该版本于 2021 年 6 月 4 日发布。
该版本修复了如下问题:
tablestyle.xml
文件的动态 PPT。该版本于 2021 年 5 月 24 日发布。
该版本优化了动态 PPT 的日志等级。
该版本于 2021 年 5 月 20 日发布。
该版本修复了特定情况下 SDK 连接服务器失败并报错 magix connect failed
的问题。
该版本于 2021 年 5 月 17 日发布。
该版本将服务端排版(useSeverWrap
)由默认关闭改为默认开启。开启服务端排版后,服务端会裁剪字体包的体积,提高渲染速度。
该版本于 2021 年 5 月 13 日发布。
该版本修复了用户设备的系统时间不准时导致实时房间的延迟出现异常的问题。
该版本于 2021 年 5 月 11 日发布。
新增
该版本新增如下特性:
修复
该版本修复了如下问题:
room.insertPlugin
时 selectable
字段不生效。该版本于 2021 年 4 月 28 日发布。
该版本新增 changeToClick
和 changeToText
,分别设置快速切换到点选工具(clicker
)和文字工具(text
)的快捷键。
该版本优化了动态 PPT 的加载速度。
该版本修复了暂停白板回放后,动态 PPT 内媒体文件没有停止播放的问题。
该版本于 2021 年 4 月 22 日发布。
该版本新增音视频裁剪功能。
该版本优化了动态 PPT 的预加载逻辑。
该版本修复了如下问题:
room.state.cameraState
更新不及时。该版本于 2021 年 4 月 21 日发布。
该版本修复了如下问题:
seekToProgressTime
方法,可能会出现异常。该版本于 2021 年 4 月 16 日发布。
该版本有如下改进:
该版本于 2021 年 4 月 15 日发布。
该版本的新增特性如下:
syncBlockTimstamp
方法,用于设置发送白板内容的延时。该方法可以用于保证白板内容与音视频同步发送。customInput
接口,用于设置自定义输入源。该版本优化了 canvas
渲染模式下的显示性能。
该版本修复了如下问题:
InvisiblePlugin
部分情况下的异常行为。该版本于 2021 年 4 月 9 日发布。
该版本支持在白板回放房间使用 Token 鉴权。
该版本修复了如下问题:
canvas
渲染引擎对图像的渲染不准确。该版本于 2021 年 4 月 6 日发布。
该版本优化了日志的上报逻辑。
该版本修复了设置跟随者模式无法立即生效的问题。
该版本于 2021 年 3 月 31 日发布,修复了如下问题:
该版本于 2021 年 3 月 29 日发布,修复了部分组件有时消失不见的问题。
该版本于 2021 年 3 月 20 日发布。
为优化笔迹显示,该版本新增笔锋效果。你可以在构造 joinRoomParams
时,设置 disableNewPencil
为 false
/true
以关闭/开启笔峰效果。
该版本改进了文字工具。
该版本修复了如下问题:
Symbol
对象使用异常。该版本于 2021 年 3 月 04 日发布,优化了网络连接。
该版本于 2021 年 3 月 04 日发布,修复了 onPPTLoadProgress
报告的文档转换任务进度不准的问题。
该版本于 2021 年 2 月 26 日发布。
该版本新增特性如下:
为丰富图形绘制工具,该版本在 ShapeType
新增以下枚举值:
triangle
:三角形rhombus
:菱形pentagram
:五角星speechBalloon
:备注气泡浮动条新增图层按钮,可以用于置顶 / 置底图片。
浮动条新增复刻按钮。
Displayer
、JoinRoomParams
和 ReplayRoomParams
中新增配置项 disableOthersSelectingBox
,可用于隐藏/显示其他用户的选择框。
ImageInformation
中新增 uniformScale
,用于设置图片为等比例缩放。
支持使用服务器端换行引擎排版结果。
该版本修复了如下问题:
关于更多版本的发版说明,详见版本历史。