| 名称 | 描述 |
|---|---|
| getSdkVersion() | 获得当前 SDK 版本号。 |
| init() | 白板 SDK 初始化。 |
| joinRoom() | 创建白板实例并加入白板房间。 |
| destroy() | 销毁 IWhiteBoardRoomManager 对象，释放资源。 |
| 名称 | 描述 |
|---|---|
| getRoomId() | 获得当前白板房间 ID。 |
| getRoomStatus() | 获取房间状态。 |
| leaveRoom() | 退出白板房间。 |
| destroyRoom() | 关闭房间内所有白板，重进房间后无法进行写画。 |
| switchWhiteBoard() | 指定当前白板。 |
| removeWhiteBoard() | 关闭指定白板。 |
| getCurrentWhiteBoard() | 获取当前的白板实例。 |
| getCurrentWhiteBoardId() | 获取当前的白板 ID。 |
| getAllWhiteBoardInfo() | 获取房间内所有白板的信息。 |
| getUserCount() | 获取房间内当前用户数。 |
| createTranscodeTask() | 创建一个转码任务。 |
| createWhiteBoard() | 在房间内创建一个白板。 |
| getWhiteBoardInfo() | 通过白板 ID 获取白板信息。 |
| startPlayback() | 开始播放白板录像。 |
| pausePlayback() | 暂停播放录像。 |
| stopPlayback() | 停止播放录像。 |
| setPlaybackProgress() | 设置白板回放进度。 |
| 名称 | 描述 |
|---|---|
| setViewMode() | 设置白板视图跟随模式。 |
| getViewMode() | 获取视图模式。 |
| removePages() | 按照指定的索引号，删除白板页。 |
| zoomIn() | 以当前视图中心为中心点放大白板视图。 |
| zoomOut() | 以当前视图中心为中心点缩小白板视图。 |
| zoomTo() | 按照指定中心点和缩放系数缩放白板视图。 |
| resetZoom() | 恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。 |
| getZoomFactor() | 获取当前白板视图缩放系数。 |
| setMaxZoom() | 设置白板视图最大放大系数。 |
| exportSnapshot() | 将当前白板中指定页面保存为一张本地图片 |
| getWhiteBoardId() | 获取当前的白板 ID。 |
| getWhiteBoardRoomId() | 获取当前白板所在的房间 ID。 |
| setWritable() | 设置当前白板是否可以编辑。 |
| getWritable() | 获取当前白板是否可以编辑。 |
| setEditType() | 设置编辑动作类型。 |
| getEditType() | 获取当前编辑动作类型。 |
| setBoardBackground() | 修改当前白板的背景设置，例如背景图片颜色等。 |
| addImage() | 在当前页面中添加图片。 |
| setSelectionBoxStyle() | 设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。 |
| setShapeSize() | 设置图形线条尺寸。 |
| setShapeColor() | 设置图形颜色。 |
| setPenSize() | 设置画笔尺寸。 |
| setPenColor() | 设置画笔颜色。 |
| setTextColor() | 设置文字颜色。 |
| setTextFontSize() | 设置文本字号大小。 |
| redo() | 重做本端对白板的编辑操作。 |
| undo() | 撤销本端对白板的编辑操作。 |
| createPages() | 创建多个白板页面。在使用文件转码功能后，可以调用本接口，将生成的多个图片批量插入到多个新的白板页面中。 |
| clearPage() | 清空白板。 |
| setPageBackground() | 修改当前白板页面的背景设置，例如背景图片颜色等。 |
| flipPage() | 白板翻页。 |
| flipNextPage() | 白板翻到下一页。 |
| flipPrevPage() | 白板翻到上一页。 |
| getAllPageInfo() | 获取所有页面信息。 |
| getCurrentPageId() | 获取当前页面的 PageId。 |
| getCurrentPageInfo() | 获取当前页面信息。 |
| getCurrentPageIndex() | 获取当前页面索引。 |
| getPageCount() | 获取当前页面总数。 |
| getPageInfoByIndex() | 通过索引号获取白板页信息。 |
| enableCursorSync() | 开启光标同步。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。默认关闭。 |
| setCursorStyle() | 自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。 |
| 名称 | 描述 |
|---|---|
| onError() | 当内部发生错误信息时回调该事件 |
| onPlaybackStateChanged() | 当白板录像播放状态发生改变时触发此回调 |
| onPlaybackProgressUpdate() | 白板录像播放进度回调。 调用 start 后触发本回调 200 ms 一次。 |
| onPlaybackDataLoaded() | 录像加载成功回调 |
| onCreateWhiteBoard() | 白板创建回调。调用 createWhiteBoard 成功创建白板后，房间内所有用户收到本回调。 |
| onUserCountChanged() | 用户进房或退房时，房间内其他用户收到本回调。 |
| onConnectionStateChanged() | SDK 与信令服务器连接状态回调。当 SDK 与信令服务器的网络连接状态改变时触发。 |
| onCurrentWhiteBoardChanged() | 当前白板被更换时，房间内其他用户收到本回调。 |
| onRemoveWhiteBoard() | 白板被删除时，房间内其他用户收到本回调。 |
| 名称 | 描述 |
|---|---|
| onBoardBackgroundChanged() | 修改白板默认背景回调。 |
| onBoardLock() | 当白板锁定状态发生改变时，将触发该回调。 |
| onCreatePagesProgress() | 已创建一个新页面回调。 |
| onRemovePages() | 删除页面回调。 |
| onClearPage() | 白板清空回调。 |
| onPageIndexChanged() | 当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调及时更新 UI 画面。 |
| onPageCountChanged() | 总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调及时更新 UI 画面。 |
| onPageBackgroundChanged() | 页面背景信息修改时触发该回调。 |
| onRecordUpdated() | 白板操作记录堆栈变化回调。 |
| onError() | 错误回调。 |
| onImageLoading() | 加载图片时触发，包含背景图片和白板页中的图片元素，例如设置背景图片和切换白板时。 |
| onZoomInfoChanged() | 本端成功调用视图缩放接口时触发本回调。 |