| 名称 | 描述 |
|---|---|
| getSdkVersion() | 获得当前SDK版本号。 |
| createWhiteBoardRoom() | 创建白板 WhiteBoardRoom |
| destroyWhiteBoardRoom() | 销毁白板房间 WhiteBoardRoom。 |
| getWhiteBoardRoom() | 通过房间ID获取白板房间对象。 |
| 名称 | 描述 |
|---|---|
| getRoomID() | 获得当前 WhiteBoardRoom 的房间 ID |
| login() | 登录即时消息服务器 |
| joinRoom() | 进房 + 调用后，本端触发 onJoinRoomResult 回调调用结果。 + 进房成功后，远端触发 onUserCountChanged 房间内人数回调。 |
| leaveRoom() | 退房 + 调用后，本端触发 onLeaveRoomResult 回调调用结果。 + 退房成功后，远端触发 onUserCountChanged 房间内人数回调。 |
| getBoardInfo() | 进房成功后，调用本接口获取当前房间内的白板信息，同时在内部恢复已有白板 // * |
| getPureBoardInfo() | 进房成功后，调用本接口获取当前房间内的白板信息 // * |
| restoreBoard() | 恢复白板 WhiteBoard |
| destroyWhiteBoard() | 销毁白板 WhiteBoard |
| createWhiteBoard() | 在房间内创建白板 |
| closeAllWhiteBoard() | 关闭所有白板，重进房间后无法进行写画。 |
| getWhiteBoard() | 通过白板 ID 获取白板对象 |
| startPlaybackWhiteBoard() | 开始播放白板录像 |
| pausePlaybackWhiteBoard() | 暂停播放录像 |
| stopPlaybackWhiteBoard() | 通过白板ID获取白板对象 |
| setPlaybackWhiteBoardProgress() | 设置白板回放进度 |
| cancelPausePlaybackWhiteBoard() | 暂停 |
| getPagePreview() |
| 名称 | 描述 |
|---|---|
| removePages() | 批量删除白板页。 |
| getWhiteBoardID() | 获取当前的白板 ID。 |
| getCurrentPageId() | 获取当前白板的 PageId。 |
| getWhiteBoardRoomID() | 获取当前白板所在的房间 ID。 |
| setEditMode() | 设置当前白板是否可以编辑。 |
| setEditType() | 设置编辑动作类型。 |
| redo() | 进行 Redo。 |
| undo() | 进行 Undo。 |
| clearPage() | 清空白板。 |
| setShapeSize() | 设置图形线条尺寸。 |
| setShapeColor() | 设置图形颜色。 |
| setPenSize() | 设置画笔尺寸。 |
| setPenColor() | 设置画笔颜色。 |
| setTextColor() | 设置文字颜色。 |
| setTextFontSize() | 设置文本字号大小。 |
| createPage() | 创建单个白板页面。 |
| createPages() | 创建多个白板页面。在使用文件转码功能后，可以调用本接口，将生成的多个图片批量插入到多个新的白板页面中。 |
| getCurrentPageInfo() | 获取当前页面信息。 |
| getAllPageInfo() | 获取所有页面信息。 |
| getCurrentPageIndex() | 获取当前页面索引。 |
| getPageInfoByIndex() | 通过索引号获取白板页信息。 |
| changePageBackground() | 修改指定白板页面的背景图或背景色。 |
| changeBoardBackground() | 修改白板默认背景图、背景色。 |
| flipPage() | 白板翻页 |
| addImage() | 在当前页面中添加图片。 |
| enableCursorSync() | 开启光标同步。 |
| setCursorStyle() | 自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。 |
| setShapeStyle() | 设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。 |
| changeBoardSize() | 设置本端白板画布大小。 |
| 名称 | 描述 |
|---|---|
| onError() | 当内部发生错误信息时回调该事件 |
| onVRTCError() | 当内部发生错误信息时回调该事件 |
| onWarning() | 告警回调 |
| onLoginResult() | 用户加入房间 |
| onJoinRoomResult() | 本端调用 joinRoom 进房的结果回调。 |
| onLeaveRoomResult() | 本端调用 leaveRoom 的退房结果回调。 |
| onPlaybackWhiteBoardStateChanged() | 回放状态回调 |
| onPlaybackWhiteBoardProgressUpdate() | 回放进度回调 |
| onCreateWhiteBoard() | 白板创建回调。进房后自动创建白板。 |
| onGetBoardInfo() | 调用 getBoardInfo 后触发本回调，返回当前房间内的白板信息。 |
| onUserCountChanged() | 当有用户进房或退房时，房间内其他端收到本回调 |
| onConnectionStateChanged() | 回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。 |
| 名称 | 描述 |
|---|---|
| onInitBoard() | 白板初始化时回调白板信息。 |
| onCreatePages() | 已创建一个新页面回调。 |
| onFlipPage() | 翻页回调。 |
| onRemovePages() | 删除页面回调。 |
| onPageIndexChanged() | 当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调及时更新 UI 画面。 |
| onPagesCountChanged() | 总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调及时更新 UI 画面。 |
| onChangePageBackground() | 页面背景信息修改时触发该回调。 |
| onChangeBoardBackground() | 修改白板默认背景回调。 |
| onWarning() | 当内部发生警告信息时回调该事件。 |
| onLockBoard() | 当白板锁定状态发生改变时，将触发该回调。 |
| onRecordUpdated() | 白板操作记录堆栈变化回调。 |
| onLockElement() | 锁定画板图形。 |
| onError() | 错误回调。 |
| onLoadingImage() | 加载画面回调。 |
| onClearPage() | 白板清空回调。 |