方法

白板SDK管理

方法 描述
enableMediaTimeSync 开启/关闭媒体同步播放

成功开启后触发 2秒一次的 onMediaSyncTimestamp 回调,拿到时间戳后与其他端进行同步
getVersion 获取白板sdk版本号。

静态方法,无需创建白板实例
outputLog 将日志写入日志文件

静态方法,无需创建白板实例
日志存放目录 ./files/Logs

白板房间管理

方法 描述
createWhiteBoardRoom 创建白板实例

创建成功后触发 onCreateWhiteBoard 白板创建回调
destroyWhiteBoardRoom 销毁白板实例
getWhiteBoardRoom 获取白板实例。创建多个房间后,可以通过调用接口获得相应实例
getRoomID 获取房间 ID
joinRoom 进房

调用后,本端触发 onJoinRoomResult 回调调用结果。

进房成功后,远端触发 onUserCountChanged 房间内人数回调。
leaveRoom 退房

调用后,本端触发 onLeaveRoomResult 回调调用结果。

退房成功后,远端触发 onUserCountChanged 房间内人数回调。

白板管理

方法 描述
getWhiteBoard 获取白板实例
getWhiteBoardID 获取当前白板 ID
getWhiteBoardRoomID 获取当前白板所属的房间 ID
setEventHandler 设置白板事件回调
closeAllWhiteBoard 关闭所有白板,重进房间后无法进行写画
白板创建后自动录制。调用本接口关闭白板以后可以开始播放录像。
录像回放路径 ./files/cache
bindToWindow 将白板绑定到 UI 控件。

调用 unBindFromWindow 进行解绑。
unBindFromWindow 解除白板和 UI 控件的绑定

调用 bindToWindow 将白板绑定到 UI 控件。
setMediaSyncTimestamp 设置时间戳

页面管理

方法 描述
createPage 新建页面
clearPage 清除页面
getCurrentPageInfo 获取当前页面信息
getAllPageInfo 获取所有页面信息
getCurrentPageIndex 获取当前页面索引
getAllPagesCount 获取白板总页数
getPageIndexByPageId 获取白板页所在索引号
getPageInfoByIndex 通过索引号获取白板页信息
changePageBackground 修改单个页面的背景图、背景色
changeBoardBackground 修改白板默认背景图、背景色
removePage
flipPage 翻页

编辑

方法 描述
setEventHandler 设置白板事件回调
setEditMode 设置当前白板是否可以编辑
hideDrawing 设置是否隐藏白板
setEditType 设置编辑模式
setPenWidth 设置笔画笔迹宽度
setPenColor 设置笔画颜色
setShapeWidth 设置形状线条宽度
setShapeColor 设置形状颜色
setTextSize 设置文本字号大小
setTextColor 设置文字颜色
undo 撤销
redo 重做

播放白板录制

方法 描述
startPlaybackWhiteBoard 开始播放白板录像

成功调用后,触发 onPlaybackWhiteBoardStateChanged 播放状态回调。
pausePlaybackWhiteBoard 暂停播放白板录像

成功调用后,触发 onPlaybackWhiteBoardStateChanged 播放状态回调。
stopPlaybackWhiteBoard 停止播放白板录像

成功调用后,触发 onPlaybackWhiteBoardStateChanged 播放状态回调。
setPlaybackWhiteBoardProgress 设置白板录像播放进度

回调

白板SDK管理

回调 描述
onWarning 告警回调
onError 错误回调
onMediaSyncTimestamp 媒体时间戳回调

白板房间管理

回调 描述
onWarning 警告
onError 错误码
onJoinRoomResult 进房结果回调
onLeaveRoomResult 退房结果回调
onCreateWhiteBoard 白板创建回调。进房后自动创建白板。
onUserCountChanged 房间内用户人数回调
远端调用 joinRoom 进房或 leaveRoom 退房后,触发本回调。

白板管理

回调 描述
onWarning 告警回调
onError 错误回调
onInitBoard 画板初始化
onWhiteBoardPrepared 白板可用回调
onWhiteBoardAttachedToWindow 白板绑定到 UI 控件。成功调用 bindToWindow 后收到此回调
onWhiteBoardDetachedToWindow 白板解除和 UI 控件的绑定。成功调用 unBindFromWindow 后收到此回调

页面管理

回调 描述
onClearPage 白板清空回调
调用 clearPage 后触发本回调。
onCreatePages 已创建一个新页面回调
onRemovePages 已删除页面回调
onChangePageBackground 页面背景信息被修改回调
onPageIndexChanged 当前页发生改变时通知(跳转或删除),以便更新 UI
onPagesCountChanged 总页数发生改变时通知(添加或删除),以便更新 UI

编辑

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

播放白板录制

回调 描述
onPlaybackWhiteBoardStateChanged 白板录像回放回调
onPlaybackWhiteBoardProgressUpdate 白板录像播放进度回调。 调用 start 后触发本回调 200 ms 一次。