方法
白板SDK管理
方法描述
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进房
leaveRoom退房
白板管理
方法描述
createWhiteBoard:pageInfo:backgroundInfo:boardNmae:创建白板。
destroyWhiteBoard:销毁本地白板实例。
getWhiteBoardByID:通过白板 ID 获取白板对象
closeWhiteBoard:关闭白板。
closeRoom关闭白板房间。关闭房间后，无法在白板上进行编辑操作。
setActiveWhiteBoard:根据白板 ID 将其指定为当前白板。
getActiveWhiteBoard获取当前白板 ID。
getAllWhiteBoardInfos获取房间内所有白板。
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:删除白板页
setViewMode:设置白板视图跟随模式。
setMaxZoom:设置白板视图最大放大系数。
zoomIn:按指定系数放大当前白板视图。
zoomOut:按指定倍数缩小当前白板视图。
zoomTo:Y:X:白板缩放&视角同步
resetZoom恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。
getZoomFactor获取当前白板视图缩放系数。
exportCurrentPageSnapshot获取当前白板页瞬照
编辑
方法描述
hideDrawing:设置是否隐藏白板
setEditType:设置编辑动作类型
setEditMode:设置当前白板是否可以编辑
setPenSize:设置画笔笔迹宽度
setPenColor:设置画笔颜色
setShapeWidth:设置形状线条宽度
setShapeColor:设置图形边框颜色
setTextFontSize:设置文本字号大小
setTextColor:设置文本颜色
setShapeStyle:设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。默认样式详见 ByteWhiteBoardAnchor。
enableCursorSync:开启光标同步功能，默认关闭。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。
setCursorStyle:自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。
addImage:X:Y:width:height:在当前页面中添加图片
undo撤销

当 byteWhiteBoard:onCanUndoStateChanged: 返回的状态为 false 时，调用本接口无效。
redo重做

当 byteWhiteBoard:onCanRedoStateChanged: 返回的状态为 false 时，调用本接口无效。
播放白板录制
方法描述
startPlaybackWhiteBoard开始播放白板录像

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

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

成功调用后，触发 byteWhiteBoardRoom:onPlaybackWhiteBoardStateChanged:errCode: 播放状态回调。
setPlaybackWhiteBoardProgress:设置白板回放进度
回调
白板SDK管理
回调描述
byteWhiteBoardRoomManager:onOccurWarning:当内部发生警告信息时回调该事件
byteWhiteBoardRoomManager:onOccurError:当内部发生错误信息时回调该事件
byteWhiteBoardRoomManager:onMediaSyncTimestamp:媒体时间戳回调
byteWhiteBoardRoomManager:onConnectionStateChanged:回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。
白板房间管理
回调描述
byteWhiteBoardRoom:onOccurWarning:当内部发生警告信息时回调该事件
byteWhiteBoardRoom:onOccurError:当内部发生错误信息时回调该事件
byteWhiteBoardRoom:onLeaveRoomResult:reason:本端调用 leaveRoom 的退房结果回调。
白板管理
回调描述
byteWhiteBoard:onOccurWarning:当内部发生警告信息时回调该事件
byteWhiteBoard:onOccurError:当内部发生不可逆转测错误时回调
byteWhiteBoard:onInitBoard:currentPageID:boardStatus:白板初始化
byteWhiteBoard:onLockBoard:reason:当白板锁定状态发生改变时，将触发该回调。
byteWhiteBoardRoom:onCloseWhiteBoard:boardId:关闭白板回调(WhiteBoard)
byteWhiteBoardRoom:onActiveWhiteBoardChanged:当前活跃的白板被改变
页面管理
回调描述
byteWhiteBoardClearPage:白板清空回调
调用 clearPage 后触发本回调。
byteWhiteBoard:onChangeBoardBackground:修改白板默认背景回调。
byteWhiteBoard:onChangePageBackground:backgroundInfo:页面背景信息修改时触发该回调。
byteWhiteBoard:onZoomInfoChanged:offstX:offstY:当前白板的视图缩放改变通知回调。
byteWhiteBoard:onViewModeChanged:本端的 ViewMode 被改变后触发本回调。
byteWhiteBoard:onExportSnapshot:filePath:白板快照回调。
编辑
回调描述
byteWhiteBoard:onCanUndoStateChanged:Undo 的状态回调，通知是否可以 Undo
byteWhiteBoard:onCanRedoStateChanged:Redo 的状态回调，通知是否可以 Redo
播放白板录制
回调描述
byteWhiteBoardRoom:onPlaybackWhiteBoardStateChanged:errCode:当白板录像播放状态发生改变时触发此回调
byteWhiteBoardRoom:onLoadPlaybackData:finish:回放数据加载完毕回调