方法

白板SDK管理

方法	描述
enableMediaTimeSync	开启/关闭时间戳回调
getVersion	获取白板 SDK 版本号。静态方法，无需创建白板实例
outputLog	将日志写入日志文件静态方法，无需创建白板实例日志存放目录 ./files/Logs

白板房间管理

方法	描述
createWhiteBoardRoom	创建白板房间实例
destroyWhiteBoardRoom	销毁白板房间实例
getWhiteBoardRoom	获取白板实例。创建多个房间后，可以通过调用接口获得相应实例
getRoomID	获取房间 ID
joinRoom	进房
leaveRoom	退房

白板管理

方法	描述
createWhiteBoard	创建白板。
getWhiteBoard	通过白板 ID 获取白板对象
getWhiteBoardID	获取当前白板 ID。
getWhiteBoardRoomID	获取当前白板所属的房间 ID。
setEventHandler	设置白板事件回调。
closeWhiteBoard	关闭白板。
closeRoom	关闭白板房间。关闭房间后，无法在白板上进行编辑操作。
setActiveWhiteBoard	根据白板 ID 将其指定为当前白板。
getActiveWhiteBoard	获取当前白板 ID。
getAllWhiteBoardInfo	获取房间内所有白板。
bindToWindow	将白板绑定到 UI 控件。调用 unBindFromWindow 进行解绑。
unBindFromWindow	解除白板和 UI 控件的绑定调用 bindToWindow 将白板绑定到 UI 控件。
setMediaSyncTimestamp	设置时间戳

页面管理

方法	描述
createPage	新建页面
clearPage	清除页面
getCurrentPageInfo	获取当前页面信息
getAllPageInfo	获取所有页面信息
getCurrentPageIndex	获取当前页面索引
getAllPagesCount	获取白板总页数
getPageIndexByPageId	获取白板页所在索引号
getPageInfoByIndex	通过索引号获取白板页信息
changePageBackground	修改单个页面的背景图、背景色
changeBoardBackground	修改白板默认背景图、背景色
removePage	批量删除白板页
flipPage	翻页
setViewMode	设置白板视图跟随模式。
setMaxZoom	设置白板视图最大放大系数。
zoomIn	按指定倍数放大当前白板视图。
zoomOut	按指定倍数缩小当前白板视图。
zoomTo	按照指定中心点和缩放系数缩放白板视图。
resetZoom	恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。
getZoomFactor	获取当前白板视图缩放系数。
exportCurrentPageSnapshot	保存当前白板快照。

编辑

方法	描述
setEventHandler	设置白板事件回调。
setEditMode	设置当前白板是否可以编辑。
hideDrawing	设置是否隐藏白板。
setEditType	设置编辑动作类型。
setPenWidth	设置笔画笔迹宽度。
setPenColor	设置笔画颜色。
setShapeWidth	设置形状线条宽度。
setShapeColor	设置形状颜色。
setTextSize	设置文本字号大小。
setTextColor	设置文字颜色。
setShapeStyle	设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。默认样式详见 ShapeStyle。
enableCursorSync	开启光标同步功能，默认关闭。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。
setCursorStyle	自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。
addImage	在当前页面中添加图片
undo	撤销当 onCanUndoStateChanged 返回的状态为 `false` 时，调用本接口无效。
redo	重做

播放白板录制

方法	描述
startPlaybackWhiteBoard	开始播放白板录像成功调用后，触发 onPlaybackWhiteBoardStateChanged 播放状态回调。
pausePlaybackWhiteBoard	暂停播放白板录像成功调用后，触发 onPlaybackWhiteBoardStateChanged 播放状态回调。
stopPlaybackWhiteBoard	停止播放白板录像成功调用后，触发 onPlaybackWhiteBoardStateChanged 播放状态回调。
setPlaybackWhiteBoardProgress	设置白板录像播放进度

回调

白板SDK管理

回调	描述
onWarning	告警回调
onError	错误回调
onMediaSyncTimestamp	媒体时间戳回调
onConnectionStateChanged	回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。

白板房间管理

白板管理

回调	描述
onWarning	告警回调
onError	错误回调
onInitBoard	画板初始化。
onWhiteBoardPrepared	白板可用回调
onWhiteBoardAttachedToWindow	白板绑定到 UI 控件。成功调用 bindToWindow 后收到此回调
onWhiteBoardDetachedToWindow	白板解除和 UI 控件的绑定。成功调用 unBindFromWindow 后收到此回调
onCloseWhiteBoard	关闭白板回调
onActiveWhiteBoardChanged	当前活跃的白板被改变

页面管理

回调	描述
onClearPage	白板清空回调调用 clearPage 后触发本回调。
onCreatePages	已创建一个新页面回调
onRemovePages	已删除页面回调
onChangePageBackground	页面背景信息修改时触发该回调。
onPageIndexChanged	当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调即使更新 UI 画面。
onPagesCountChanged	总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调即使更新 UI 画面。
onZoomInfoChanged	当前白板的视图缩放改变通知回调。
onViewModeChanged	本端的 ViewMode 被改变后触发本回调。
onExportSnapshot	白板快照回调。

编辑

回调	描述
onCanUndoStateChanged	可撤销状态改变的回调
onCanRedoStateChanged	可重做状态改变的回调

播放白板录制

回调	描述
onPlaybackWhiteBoardStateChanged	白板录像回放回调
onPlaybackWhiteBoardProgressUpdate	白板录像播放进度回调。调用 start 后触发本回调 200 ms 一次。
onLoadPlaybackData	回放数据加载完毕回调