概览

最近更新时间:2023-07-14 08:47:02

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画板背景图片加载状态回调