You need to enable JavaScript to run this app.
导航

白板 SDK 发版说明

最近更新时间2024.02.20 20:19:35

首次发布时间2022.11.21 14:42:25

veWhiteboard SDK 1.8.1

该版本于 2024 年 1 月 10 日发布。

功能优化

  1. 大幅降低白板交互延迟时间。
  2. Web 端发起文档转码任务时,支持设置 URL 的过期时间,参见 createTranscodeTask

veWhiteboard SDK 1.8

该版本于 2023 年 10 月 20 日发布。

新增特性

互动白板新增了插入音视频文件的能力。用户可以通过播放器交互,控制已插入的音视频文件。

AndroidiOSWeb
添加视频addVideoaddVideo:title:completionHandler:addVideo
添加音频addAudioaddAudio:title:completionHandler:addAudio

veWhiteboard SDK 1.7

该版本于 2023 年 9 月 15 日发布。
互动白板的 400 ms 延时达标率达到了 98.6%,同时修复了一些已知缺陷。

移动端 veWhiteboard SDK 1.6.2

该版本于 2023 年 8 月 25 日发布。
提升了 SDK 兼容性能,详见产品概述,同时修复了一些已知缺陷。

升级必看

  1. 移动端设置播放进度接口增加参数,用于接收调用结果回调。
平台AndroidiOS
设置播放进度setPlaybackProgresssetPlaybackProgress:block:
  1. 移动端页面创建结果回调参数变化增加 totalCount 参数,返回总页数。同时废弃 insertPageId 参数。
平台AndroidiOS
页面创建结果回调onCreatePagesProgressbyteWhiteBoard:onCreatePagesProgress:pages:insertPageId:progress:totalCount:
  1. iOS 端 ByteWhiteBoardCursorType 鼠标选择工具枚举值变更。变更后与其他端相应枚举的名称和数值保持统一。
变更前变更后
枚举值名称ByteWhiteBoardCursorTypeNormalByteWhiteBoardCursorTypePointer
数值10

Web 端 veWhiteboard SDK 1.6.1

该版本于 2023 年 8 月 25 日发布。
提升了 SDK 兼容性能,详见构建 Web 白板应用,同时修复了一些已知缺陷。

升级必看

Web 端 WebPageInfo 的类型名称变更为 WebPageCreateInfo

微信小程序端 veWhiteboard SDK 1.0

2023 年 8 月 3 日,微信小程序端 veWhiteboard SDK 首个对外版本 1.0 正式发布。

新增特性

  • 多人白板互动。
  • 支持将上传文档,转换为图片,共享到微信小程序端白板房间中。
  • 支持切换白板和翻页操作。

已知问题和使用限制

由于平台限制和应用场景差异,小程序端只支持了部份其他端已有能力。
比如,不支持涂鸦等图形工具,也不支持同步其他端的笔迹。
主播通过小程序端开播时,建议其他参与者也都通过小程序端进房互动。

veWhiteboard SDK 1.6

该版本于 2023 年 7 月 23 日发布。

此次升级包含的客户端系统有:Android、iOS、Web,如无特别说明,涉及的新增或变动在上述 3 个端均适用。

新增特性

文档转码新增动态转码支持。可以在客户端或服务端上传 PPT 文件,转码后共享到白板房间内。用户可以控制 PPT 中的动画,播放多媒体等。详见文档转码以下接口说明:

AndroidiOSWeb
创建文档转码任务的接口可在参数中选择为动态转码,并提供相应的信息NoneNonecreateTranscodeTask
创建 PPT 白板createFileWhiteBoardcreateFileWhiteBoard:boardName:pptInfo:createFileWhiteBoard
白板创建成功回调。当新创建的白板为 PPT 白板时,会回调相应的 pptInfoonCreateWhiteBoardbyteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:pptInfo:onCreateWhiteBoard
获取 PPT 信息getPptInfogetPptInfo:getPptInfo
下一个 PPT 动画pptNextSteppptNextSteppptNextStep
上一个 PPT 动画pptPrevSteppptPrevSteppptPrevStep
PPT 动画改变回调onPptStepChangedbyteWhiteBoard:onPptStepChanged:currentStep:totalStep:currentPageIndex:onPptStepChanged

升级必看

  1. 快照接口参数变化,新增参数设置是否导出笔迹。同时,回调的参数变更,pageId 变成 pageIndex。详见如下对比和接口说明。
1.51.6
Androidpublic abstract void com.ss.video.byteboard.WhiteBoard.exportSnapshot(
String pageId,
boolean withBackGround)

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onExportSnapshot(
String pageId,
String filePath)
public abstract void com.ss.video.byteboard.WhiteBoard.exportSnapshot(
Integer pageIndex,
boolean withElements,
boolean withBackGround)

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onExportSnapshot(
int pageIndex,
String filePath)
iOS- (void)exportSnapshot:(NSString *)pageId withBackGround:(BOOL)isBackGround;- (void)exportSnapshot:(NSInteger)pageIndex withElements:(BOOL)isElements withBackGround:(BOOL)isBackGround;
Webexport type ExportSnapshotOptions = {
pageIndex?: number;
withBackGround?: boolean;
};
export interface ExportSnapshotOptions {
pageIndex?: number;
withElements?: boolean;
withBackGround?: boolean;
}
  1. Web 端删除了 getRoomUserCount 接口和回调 onUserCountChanged
  2. Web 端 setPlaybackProgress ,返回的类型从 void 变更为 Promise<void>
  3. Web 端 destroyRoom 调用成功后,返回的类型变更。
1.51.6
() => Promise<CloseRoomResult>() => Promise<DestroyRoomResult>

veWhiteboard SDK 1.5

该版本于 2023 年 4 月 25 日发布。
此次升级包含的客户端系统有:Android、iOS、Web,如无特别说明,涉及的新增或变动在上述 3 个端均适用。

升级必看

该版本对多个 API 进行了优化,升级时建议根据最新版本快速开始 Demo 进行集成和接入。

新增特性

  1. 你可以通过 getCurrentWhiteBoardId 获取当前白板 ID。
AndroidiOSWeb
getCurrentWhiteBoardIDgetCurrentWhiteBoardId:getCurrentWhiteBoardId
  1. 你可以通过 getRoomStatus 感知房间状态。
AndroidiOSWeb
getRoomStatusgetRoomStatus:getRoomStatus
  1. 在 Web 端,你可以通过 getUserCount() 获取房间内当前用户数。

veWhiteboard SDK 1.4

该版本于 2023 年 2 月 8 日发布。
此次升级包含的客户端系统有:Android、iOS、Web,如无特别说明,涉及的新增或变动在上述 3 个端均适用。

升级必看

  1. API 名称变更。
接口变更前变更后
关闭所有白板closeAllWhiteBoardcloseRoom
  1. 移动端创建和获取首个白板的途径变更。
接口变更前变更后
创建白板用户进房后,如果当前白板房间未创建白板,SDK 将自动创建白板,并触发 onCreateWhiteBoard, 返回该白板。用户进房后,需要 调用 createWhiteBoard 手动创建白板。仍可通过 onCreateWhiteBoard 获取刚创建的白板。
  1. iOS 端部分 API 和回调名称由大驼峰统一为小驼峰。
接口变更前变更后
获取所有页面GetAllPageInfogetAllPageInfo
获取页面总数GetAllPagesCountgetAllPagesCount
获取 PageIdGetPageIndexWhitPageId:getPageIndexWhitPageId:
设置时间戳SetMediaSyncTimestamp:setMediaSyncTimestamp:
页面背景变更回调OnChangePageBackground:backgroundInfo:byteWhiteBoard:onChangePageBackground:backgroundInfo:
白板背景变更回调OnChangeBoardBackground:byteWhiteBoard:onChangeBoardBackground:
白板创建回调OnWhiteBoardCreated:elapsed:createWhiteBoard:pageInfo:backgroundInfo:boardNmae:
连接状态改变回调OnConnectionStateChanged:byteWhiteBoardRoom:onConnectionStateChanged:

新增特性

  1. 单个房间内支持多个白板,用户可以切换不同白板进行操作和互动。详见以下接口的 API 文档。
接口AndroidiOSWeb
创建白板createWhiteBoardcreateWhiteBoard:pageInfo:backgroundInfo:boardNmae:createWhiteBoard
关闭当前白板closeWhiteBoardcloseWhiteBoard:closeWhiteBoard()
设置当前白板setActiveWhiteBoardsetActiveWhiteBoard:setActiveWhiteBoard
获取当前白板getActiveWhiteBoardgetActiveWhiteBoardgetActiveWhiteBoard
获取所有白板getAllWhiteBoardInfogetAllWhiteBoardInfosgetAllWhiteBoardInfo
白板关闭回调onCloseWhiteBoardbyteWhiteBoardRoom:onCloseWhiteBoard:boardId:onCloseWhiteBoard
当前白板改变回调onActiveWhiteBoardChangedbyteWhiteBoardRoom:onActiveWhiteBoardChanged:onActiveWhiteBoardChanged
  1. 新增视图缩放功能,可选择是否将缩放同步到其他观众,也可以选择是否接收演讲人的缩放设置。详见以下接口的 API 文档。
接口AndroidiOSWeb
画报编辑工具新增缩放平移工具setEditTypesetEditType:setEditType
设置是否同步缩放设置setViewModesetViewMode:setViewMode
设置最大缩放setMaxZoomsetMaxZoom:setMaxZoom
放大zoomInzoomIn:zoomIn
缩小zoomOutzoomOut:zoomOut
指定中心点缩放白板zoomTozoomTo:Y:X:zoomTo
视图恢复默认大小resetZoomresetZoomresetZoom
获取当前缩放系数getZoomFactorgetZoomFactorgetZoomFactor
白板缩放回调onZoomInfoChangedbyteWhiteBoard:onZoomInfoChanged:offstX:offstY:onZoomInfoChanged
缩放同步开关变更回调onViewModeChangedbyteWhiteBoard:onViewModeChanged:Web 通过 setViewMode 返回的 Promise 感知本端 ViewMode 变化。
  1. 新增白板快照和导出功能。详见以接口的 API 文档。
平台AndroidiOSWeb
接口exportCurrentPageSnapshotexportCurrentPageSnapshotexportCurrentPageSnapshot
回调onExportSnapshotbyteWhiteBoard:onExportSnapshot:filePath:Web 通过 exportCurrentPageSnapshot 返回的 Promise 接收快照地址。

功能优化

白板录像回放功能模块增加加载完成回调。你可以通过监听以下回调,提示用户和对白板录像进行播放。

接口AndroidiOSWeb
白板录像加载完成回调onLoadPlaybackDatabyteWhiteBoardRoom:onLoadPlaybackData:finish:onLoadPlaybackData

veWhiteboard SDK 1.3.4

该版本于 2022 年 12 月 16 日发布。

缺陷修复。

veWhiteboard SDK 1.3.0

该版本于 2022 年 12 月 5 日发布。

首次发布了移动端的 Beta 版本,包括 Android 和 iOS。

新增特性

  1. 新增光标同步开关。开启后,房间中其他成员可以看到本端用户的光标轨迹。
AndroidiOSWeb
enableCursorSyncenableCursorSync:enableCursorSync
  1. 支持在画布中添加在线图片。
AndroidiOSWeb
addImageaddImage:X:Y:width:height:addImage
  1. 支持自定义笔迹、图形等工具的光标图标。
AndroidiOSWeb
setCursorStylesetCursorStyle:setCursorStyle
  1. 支持自定义选择框和锚点的样式。
AndroidiOSWeb
setShapeStylesetShapeStyle:setShapeStyle()
  1. 新增网络状态回调。你可以通过该回调,感知本端与服务器的连接状态。
AndroidiOSWeb
onConnectionStateChangedbyteWhiteBoardRoomManager:OnConnectionStateChanged:onConnectionStateChanged
  1. Web 端新增 changeBoardSize,调整本端的画布大小。

veWhiteboard SDK 1.2.0

该版本于 2022 年 11 月 21 日发布,是首个对外发布的 Beta 版本。