| 方法 | 描述 |
|---|---|
| sharedEngineWithAppId:delegate: | 创建白板 ByteWhiteBoardRoomManager 单例对象 |
| destroy | 销毁白板 ByteWhiteBoardRoomManager 单例对象 |
| setDeviceID: | 设置设备id |
| setLogLocation: | 设置本地日志缓存路径 |
| setCacheLocation: | 设置数据缓存路径 |
| setAid: | 设置App ID |
| updateByteWhiteBoardRoomManagerDelegate: | 更新 ByteWhiteBoardRoomManager 的delegate |
| enableMediaTimeSync: | 开启媒体同步功能 |
| 方法 | 描述 |
|---|---|
| createWhiteBoardRoom:userID:token:delegate: | 创建白板 WhiteBoardRoom |
| destroyWhiteBoardRoom: | 销毁白板房间 WhiteBoardRoom |
| getWhiteBoardRoom: | 通过房间 ID 获取白板房间对象 |
| updateByteWhiteBoardRoomDelegate: | 更新回调手柄 |
| getRoomID | 获得当前WhiteBoardRoom的房间ID |
| joinRoom | 进房 调用后，本端触发 byteWhiteBoardRoom:onJoinRoomResult:userID:errCode:isRejoin: 回调调用结果。 房间内首个用户进房成功后自动创建白板 并触发 byteWhiteBoardRoom:onWhiteBoardCreated:elapsed: 回调。 进房成功后，远端触发 byteWhiteBoardRoom:onUserCountChanged: 房间内人数回调。 |
| leaveRoom | 退房 调用后，本端触发 byteWhiteBoardRoom:onLeaveRoomResult:reason: 回调调用结果。 退房成功后，远端触发 byteWhiteBoardRoom:onUserCountChanged: 房间内人数回调。 |
| 方法 | 描述 |
|---|---|
| destroyWhiteBoard: | 销毁白板 WhiteBoard |
| getWhiteBoardByID: | 通过白板ID获取白板对象 |
| closeAllWhiteBoard | 关闭所有白板，重进房间后无法进行写画 白板创建后自动录制。调用本接口关闭白板以后可以开始播放录像。 录像回放路径 ./AppData/Library/Caches |
| updateByteWhiteBoardDelegate: | 设置事件回调 |
| getWhiteBoardID | 获取当前白板的ID |
| getWhiteBoardRoomID | 获取当前白板的房间号 |
| changeWholeBoardBackgroundWhitBkInfo: | 修改整个board的所有页的背景 |
| bindToWindow: | 把画板UI绑定到某个view上 |
| bindToWindowWithConfig: | 把画板UI绑定到某个view上 |
| unbindFromWindow | 取消画板UI绑定 |
| SetMediaSyncTimestamp: | 设置同步时间戳 |
| 方法 | 描述 |
|---|---|
| getCurrentPageID | 获取当前白板的PageID |
| flipPage: | 白板翻页 调用成功后在房间内所有客户端触发 byteWhiteBoard:onPageIndexChanged:pageInfo: |
| createPage:config:isAutoFlip: | 新建白板页 |
| createMultiPages:configs:isAutoFlip: | 新建多个白板页 |
| changePageBackgroundWhitPageID:bkInfo: | 修改白板页背景 |
| getCurrentPageInfo | 获取当前页面信息 |
| GetAllPageInfo | 获取所有页面信息 |
| getCurrentPageIndex | 获取当前页面索引 |
| GetAllPagesCount | 获取白板总页数 |
| GetPageIndexWhitPageId: | 获取白板页所在索引号 |
| getPageInfoWhitIndex: | 通过索引号获取白板页信息 |
| removePage: | 删除白板页 |
| 方法 | 描述 |
|---|---|
| hideDrawing: | 设置是否隐藏白板 |
| setEditType: | 设置动作类型 |
| setEditMode: | 设置当前白板是否可以编辑 |
| setPenSize: | 设置画笔笔迹宽度 |
| setPenColor: | 设置画笔颜色 |
| setShapeWidth: | 设置形状线条宽度 |
| setShapeColor: | 设置图形边框颜色 |
| setTextFontSize: | 设置文本字号大小 |
| setTextColor: | 设置文本颜色 |
| undo | 撤销 当 byteWhiteBoard:onCanUndoStateChanged: 返回的状态为 false 时，调用本接口无效。 |
| redo | 重做 当 byteWhiteBoard:onCanRedoStateChanged: 返回的状态为 false 时，调用本接口无效。 |
| 方法 | 描述 |
|---|---|
| startPlaybackWhiteBoard | 开始播放白板录像 成功调用后，触发 byteWhiteBoardRoom:onPlaybackWhiteBoardStateChanged:errCode: 播放状态回调。 |
| pausePlaybackWhiteBoard | 暂停播放白板录像 成功调用后，触发 byteWhiteBoardRoom:onPlaybackWhiteBoardStateChanged:errCode: 播放状态回调。 |
| stopPlaybackWhiteBoard | 停止播放白板录像 成功调用后，触发 byteWhiteBoardRoom:onPlaybackWhiteBoardStateChanged:errCode: 播放状态回调。 |
| setPlaybackWhiteBoardProgress: | 设置白板回放进度 |
| 回调 | 描述 |
|---|---|
| byteWhiteBoardRoomManager:onOccurWarning: | 当内部发生警告信息时回调该事件 |
| byteWhiteBoardRoomManager:onOccurError: | 当内部发生错误信息时回调该事件 |
| byteWhiteBoardRoomManager:onMediaSyncTimestamp: | 媒体时间戳回调 调用 enableMediaTimeSync: 开启后，将触发 2 秒一次周期性回调，返回时间戳，将时间戳传递给被动同步的对象实现同步播放 |
| 回调 | 描述 |
|---|---|
| byteWhiteBoardRoom:onOccurWarning: | 当内部发生警告信息时回调该事件 |
| byteWhiteBoardRoom:onOccurError: | 当内部发生错误信息时回调该事件 |
| byteWhiteBoardRoom:onLeaveRoomResult:reason: | 离房结果回调 |
| byteWhiteBoardRoom:onUserCountChanged: | 房间内用户人数回调 远端调用 joinRoom 进房或 leaveRoom 退房后，触发本回调。 |
| 回调 | 描述 |
|---|---|
| byteWhiteBoard:onOccurWarning: | 当内部发生警告信息时回调该事件 |
| byteWhiteBoard:onOccurError: | 当内部发生不可逆转测错误时回调 |
| byteWhiteBoard:onInitBoard:currentPageID:boardStatus: | 画板初始化 |
| byteWhiteBoard:onLockBoard:reason: | 锁定画板 UI |
| 回调 | 描述 |
|---|---|
| byteWhiteBoard:onCanUndoStateChanged: | Undo 的状态回调，通知是否可以 Undo |
| byteWhiteBoard:onCanRedoStateChanged: | Redo 的状态回调，通知是否可以 Redo |
| 回调 | 描述 |
|---|---|
| byteWhiteBoardRoom:onPlaybackWhiteBoardStateChanged:errCode: | 当白板录像播放状态发生改变时触发此回调 |
| byteWhiteBoardRoom:onWhiteBoardCreated:elapsed: | 白板创建回调。进房后自动创建白板。 |