白板事件回调

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

概览

ARBoardHandler 接口类向 App 发送回调通知,上报运行时的事件。

ARBoardHandler 包含了以下方法:

全局事件回调
onAddBoard添加白板页回调
onDeleteBoard删除白板页回调
onGotoBoard白板页切换回调
onUndoStateChange当前白板页是否可撤销
onRedoStateChange当前白板页是否可重做
onOccurError白板错误回调
onScaleChannge当前白板页缩放比例变化回调
connectionChangedToState网络状态回调
onSnapshot截图回调
onHistoryDataSyncCompleted白板数据同步完成回调
onBoardReset白板重置时回调
onBoardClear白板被清空时回调
onBoardImageStatusChanged画板背景图片加载状态回调
onBoardRatioChange画板背景图片加载状态回调

onAddBoard

void onAddBoard(String boardIds, String fileId);

添加白板页的回调

参数描述
boardIds白板页 ID 列表
fileId白板的文件 ID

onDeleteBoard

void onDeleteBoard(String boardIds, String fileId);

删除白板页的回调

参数描述
boardIds白板页 ID 列表
fileId白板的文件 ID

onGotoBoard

void onGotoBoard(String boardIds, String fileId);

白板页切换的回调

参数描述
boardIds白板页 ID 列表
fileId白板的文件 ID

onUndoStateChange

void onUndoStatusChanged(boolean enable);

当前白板页是否可撤销

参数描述
enable白板是否可执行 undo 操作

onRedoStateChange

void onRedoStatusChanged(boolean enable);

当前白板页是否可重做

参数描述
enable白板是否可执行 redo 操作

onOccurError

void onOccurError(ARBoardErrorCode err, String message);

当前白板页是否可重做

参数描述
err错误类型
message错误信息

scaleChannge

void onScaleChanged(String boardId, int scale);

白板页缩放的回调

参数描述
boardId缩放变化的白板页 ID
scale缩放比例

connectionChangedToState

void connectionChangedToState(ARBoardConnectionState state, ARBoardConnectionChangedReason reason);

白板页缩放的回调

参数描述
state当前的网络连接状态
reason触发当前网络连接状态的原因

onSnapshot

void onSnapshot(String path, ARBoardSnapshotCode code);

截图回调

参数描述
path快照本地输出路径
code状态码

onhistorydatasynccompleted

void onHistoryDataSyncCompleted();

数据同步完成回调
注:操作白板需在回调此方法后(getter setter.. 等)

onBoardReset

void onBoardReset();

画板被重置时会执行此方法

onBoardClear

void onBoardClear(String boardId, String fileId, boolean clearBackground);

画板被清空时会执行此方法

参数描述
boardId快照本地输出路径
fileId白板的文件 ID
clearBackground是否清空背景,背景包括颜色&图片

onBoardImageStatusChanged

void onBoardImageStatusChanged(String boardId, String fileId, ARBoardImageStatus status, String imgUrl, ARBoardFillMode fillMode)

画板背景图片加载状态回调,ARBoardImageStatus详见ARBoardImageStatus、ARBoardFillMode详见ARBoardFillMode

参数描述
boardId快照本地输出路径
fileId白板的文件 ID
status设置背景图片后的图片加载状态
imgUrl背景图片地址
fillMode背景图片填充方式

onBoardRatioChange

void onBoardRatioChange(String boardId, String ratio)

当前白板页比例变更时回调

参数描述
boardId快照本地输出路径
ratio当前画板比例,如:"4:3"