anyRTC 通过全球部署的虚拟网络,提供可以灵活搭配的 API 组合,为移动端到移动端以及移动端到 Web 端提供质量可靠的白板互动服务
核心类
类名 | 描述 |
---|---|
ARBoardKit | 白板 SDK 的入口类,提供所有可供 App 调用的方法 |
ARBoardHandler | 白板 SDK 事件回调 |
核心方法
方法 | 描述 |
---|---|
joinChannelByToken | 加入房间 |
leaveChannel | 离开房间 |
涂鸦相关
方法 | 描述 |
---|---|
clear | 清空当前白板页数据默认只清除当前白板页的涂鸦,如果 clearBackground 参数为 true,则同时清除涂鸦和背景 |
getBrushColor | 获取画笔颜色 |
getBrushThin | 获取画笔粗细 |
getToolType | 获取画笔类型 |
isDrawEnable | 获取白板是否可涂鸦 |
getTextColor | 获取设置的文字颜色 |
getTextSize | 获取设置的文字大小 |
resize | 重新计算白板大小,并渲染 |
setBrushColor | 设置画笔颜色 |
setBrushThin | 设置画笔粗细 |
setToolType | 设置画笔工具类型 |
setDrawEnable | 设置白板是否可涂鸦 |
setTextColor | 设置的文字颜色 |
setTextSize | 设置文字的大小 |
白板页操作接口
方法 | 描述 |
---|---|
addBoard | 添加一页白板并切换到这一页 |
deleteBoard | 删%除当前白板页并切换到上一页 |
getBoardList | 获取所有文件的白板列表 |
getBoardScale | 获取当前白板页缩放比例 |
snapshot | 保存截图 |
getCurrentBoardId | 获取当前白板页 ID |
getCurrentFile | 获取当前文件 ID |
getFileBoardList | 获取指定文件的白板 ID 列表 |
getFileInfo | 获取白板的基本信息 |
gotoBoard | 切换到指定的白板页 |
nextBoard | 切换到下一页白板 |
prevBoard | 切换到上一页白板 |
reset | 重置白板 |
setBoardScale | 设置当前白板页的缩放大小 |
setBoardRatio | 设置当前白板页的比例 |
getBoardRatio | 返回当前白板页的比例 |
背景相关
方法 | 描述 |
---|---|
getBackgroundColor | 获取当前白板页的背景颜色 |
getGlobalBackgroundColor | 获取全局设置的白板页背景颜色 |
setBackgroundColor | 设置当前白板页的背景颜色 |
setGlobalBackgroundColor | 全局设置白板页的背景颜色 |
setBackgroundImage | 设置当前白板页背景图片及填充模式 |
getBackgroundImage | 获取当前白板页背景图片 |
getBackgroundImageFillMode | 获取当前白板页背景图片的填充模式 |
撤销和恢复相关
方法 | 描述 |
---|---|
redo | 画笔重做 |
undo | 撤销画笔 |
其他
方法 | 描述 |
---|---|
getVersion | 获取 SDK 版本 |
setParameters | 自定义配置 |
事件回调
方法 | 描述 |
---|---|
onAddBoard | 添加白板页回调 |
onDeleteBoard | 删除白板页回调 |
onGotoBoard | 白板页切换回调 |
onUndoStateChange | 当前白板页是否可撤销 |
onRedoStateChange | 当前白板页是否可重做 |
onOccurError | 白板错误回调 |
onScaleChannge | 当前白板页缩放比例变化回调 |
connectionChangedToState | 网络状态回调 |
onSnapshot | 截图回调 |
onHistoryDataSyncCompleted | 数据同步完成回调 |
onBoardReset | 白板重置时回调 |
onBoardClear | 白板被清空时回调 |
onBoardImageStatusChanged | 画板背景图片加载状态回调 |
onBoardRatioChange | 画板背景图片加载状态回调 |