Agora Interactive Whiteboard Web SDK API Reference
声网通过全球部署的虚拟网络，提供可以灵活搭配的 API 组合，提供稳定可靠、功能丰富的实时互动白板。
-
WhiteWebSdk 类提供初始化互动白板 SDK、加入互动白板实时房间、创建白板回放的主要方法。
-
Room 接口提供管理互动白板实时房间的方法。
-
Player 接口提供控制白板回放的方法。
-
Displayer 接口为 Room 接口和 Player 接口的父接口。Room 和 Player 对象都可以调用该接口中的方法。
SDK 初始化
| 方法 | 描述 |
|---|---|
| WhiteWebSdk | 初始化 WhiteWebSdk 实例 |
| Callbacks | 设置事件回调 |
| joinRoom | 加入互动白板实时房间并设置房间事件回调 |
| replayRoom | 创建互动白板回放房间并设置回放事件回调 |
| isPlayable | 查看房间是否有回放数据 |
| WhiteVersion | 查询 SDK 版本号 |
实时房间管理
| 方法 | 描述 |
|---|---|
| setWritable | 设置用户是否为互动模式 |
| disconnect | 断开用户与实时房间的连接 |
| setGlobalState | 修改房间的全局状态 |
| isWritable | 获取用户是否为互动模式 |
白板工具设置
| 方法 | 描述 |
|---|---|
| setMemberState | 修改房间的白板工具状态 |
| MemberState | 获取白板工具状态 |
| copy | 复制选中内容 |
| paste | 粘贴复制的内容 |
| duplicate | 复制并粘贴选中的内容 |
| delete | 删除选中的内容 |
| disableSerialization | 开启/禁止本地序列化 |
| redo | 重做 |
| undo | 撤销上一步操作 |
| disableEraseImage | 关闭/开启橡皮擦擦除图片功能 |
| disableDeviceInputs | 禁止/允许用户操作白板工具 |
视角操作
| 方法 | 描述 |
|---|---|
| setViewMode | 切换视角模式 |
| setCameraBound | 设置视角边界 |
| disableCameraTransform | 禁止/允许用户调整（移动或缩放）视角 |
| moveCamera | 调整视角 |
| moveCameraToContain | 调整视角以完整显示视觉矩形中的内容 |
| scalePptToFit | 调整视角以完整显示 PPT 的内容（指定动画模式） |
| BroadcastState | 获取用户的视角状态 |
场景管理
| 方法 | 描述 |
|---|---|
| insertImage | 插入图片占位符 |
| completeImageUpload | 展示图片 |
| SceneState | 获取当前场景目录下的场景状态 |
| createScenesCallback | 创建场景目录的监听器对象 |
| SceneMap | 获取当前场景目录下的场景列表 |
| getScene | 获取指定场景的信息 |
| setScenePath | 切换至指定的场景 |
| setSceneIndex | 切换至当前场景目录下的指定场景 |
| putScenes | 在指定场景目录下插入多个场景 |
| moveScene | 移动场景 |
| exportScene | 导出场景 |
| importScene | 导入场景 |
| removeScenes | 删除场景或者场景目录 |
| cleanCurrentScene | 清除当前场景的所有内容 |
| lockImages | 锁定选中图片 |
| insertText | 在指定位置插入文字 |
| updateText | 修改指定的文字 |
| updateSelectedText | 修改当前被选中文字的字体样式 |
| pptNextStep | 播放动态 PPT 下一页 |
| pptPreviousStep | 返回动态 PPT 上一页 |
| scenePathType | 查询场景路径类型 |
| entireScenes | 获取当前房间内所有场景的信息 |
| scenePreview | 获取指定场景的预览图 |
| generateScreenshot | 获取指定场景的截图 |
| fillSceneSnapshot | 获取指定场景的屏幕快照 |
回放管理
| 方法 | 描述 |
|---|---|
| playbackSpeed | 设置白板回放的倍速 |
| play | 开始白板回放 |
| pause | 暂停白板回放 |
| stop | 停止白板回放 |
| seekToProgressTime | 设置白板回放的播放位置 |
| setObserverMode | 设置白板回放的查看模式 |
自定义事件
| 方法 | 描述 |
|---|---|
| dispatchMagixEvent | 发送自定义事件 |
| addMagixEventListener | 注册自定义事件监听 |
| removeMagixEventListener | 移除自定义事件监听 |
其他方法
| 方法 | 描述 |
|---|---|
| timeDelay | 设置白板同步延时 |
| convertToPointInWorld | 转换白板上点的坐标 |
| refreshViewSize | 刷新白板的界面 |
| createPPTTask | 创建 PPTTask 对象 |
事件回调
| 事件 | 描述 |
|---|---|
| DisplayerCallbacks | Displayer 对象的事件回调 |
| RoomCallbacks | 白板房间的事件回调 |
| PlayerCallbacks | 白板回放的事件回调 |
| PPTTaskCallbacks | 文档转换任务的进度和结果回调 |