Agora Interactive Whiteboard Objective-C Overview Document
声网通过全球部署的虚拟网络，提供可以灵活搭配的 API 组合，提供稳定可靠、功能丰富的实时互动白板。
-
WhiteSDK 类提供初始化互动白板 SDK、加入互动白板实时房间、创建白板回放的主要方法。
-
WhiteRoom 类提供管理互动白板实时房间的方法。
-
WhitePlayer 类提供控制白板回放的方法。
-
WhiteDisplayer 类为 WhitePlayer 类和 WhiteRoom 类的父类。WhitePlayer 和 WhiteRoom 的对象都可以调用该类中的方法。
SDK 初始化
| 方法 | 描述 |
|---|---|
| initWithWhiteBoardView | 初始化白板界面（设置回调） |
| initWithWhiteBoardView | 初始化白板界面（设置回调和混音） |
| WhiteCommonCallbackDelegate | 设置通用事件回调 |
| joinRoomWithConfig | 设置房间参数和房间事件回调并加入互动白板实时房间 |
| createReplayerWithConfig | 创建互动白板回放房间 |
| isPlayable | 查看房间是否有回放数据 |
| setupFontFaces | 声明在本地白板中可用的字体 |
| loadFontFaces | 声明并预加载在本地白板中可用的字体 |
| updateTextFont | 设置在本地白板中输入文字时使用的字体 |
通用事件
| 事件 | 描述 |
|---|---|
| throwError | 出现未捕获的全局错误回调 |
| urlInterrupter | 拦截图片 URL 回调 |
| pptMediaPlay | 动态 PPT 中的音视频开始播放回调 |
| pptMediaPause | 动态 PPT 中的音视频赞同播放回调 |
| customMessage | 接收到网页发送的消息回调 |
| sdkSetupFail | SDK 初始化失败回调 |
实时房间管理
| 方法 | 描述 |
|---|---|
| observerId | 获取用户 ID |
| setWritable | 设置用户是否为互动模式 |
| disableDeviceInputs | 禁止/允许用户操作工具 |
| disconnect | 断开连接 |
| setGlobalState | 修改房间的全局状态 |
| disconnectedBySelf | 获取用户是否主动断开连接 |
| writable | 获取用户是否为互动模式 |
| globalState | 获取房间的全局状态（同步方法） |
| getGlobalStateWithResult | 获取房间的全局状态（异步方法） |
| roomMembers | 获取房间的用户列表（同步方法） |
| getRoomMembersWithResult | 获取房间的用户列表（异步方法） |
| phase | 获取房间的连接状态（同步方法） |
| getRoomPhaseWithResult | 获取房间的连接状态（异步方法） |
| state | 获取房间的所有状态（同步方法） |
| getRoomStateWithResult | 获取房间的所有状态（异步方法） |
白板工具设置
| 方法 | 描述 |
|---|---|
| setMemberState | 修改房间的白板工具状态 |
| memberState | 获取白板工具状态（同步方法） |
| getMemberStateWithResult | 获取白板工具状态（异步方法） |
| copy | 复制选中内容 |
| paste | 粘贴复制的内容 |
| duplicate | 复制并粘贴选中的内容 |
| deleteOpertion | 删除选中的内容 |
| disableSerialization | 开启/禁止本地序列化 |
| redo | 重做 |
| undo | 撤销上一步操作 |
| disableEraseImage | 关闭/开启橡皮擦擦除图片功能 |
| disableDeviceInputs | 禁止/允许用户操作白板工具 |
视角操作
| 方法 | 描述 |
|---|---|
| setViewMode | 切换视角模式 |
| setCameraBound | 设置视角边界 |
| disableCameraTransform | 禁止/允许用户调整视角 |
| moveCamera | 调整视角 |
| moveCameraToContainer | 调整视角以完整显示视觉矩形中的内容 |
| scalePptToFit | 调整视角以完整显示 PPT 的内容 |
| disableCameraTransform | 禁止/允许用户调整（移动或缩放）视角 |
| broadcastState | 获取用户的视角状态（同步方法） |
| getBroadcastStateWithResult | 获取用户的视角状态（异步方法） |
场景管理
| 方法 | 描述 |
|---|---|
| insertImage1 | 插入图片显示区域 |
| completeImageUploadWithUuid | 展示图片 |
| insertImage2 | 插入并展示图片 |
| insertText | 在指定位置插入文字 |
| sceneState | 获取当前场景目录下的场景状态（同步方法） |
| getSceneFromScenePath | 获取指定场景的信息 |
| getSceneStateWithResult | 获取当前场景目录下的场景状态（异步方法） |
| getScenesWithResult | 获取当前场景目录下的场景列表 |
| setScenePath | 切换至指定的场景（同步方法） |
| setScenePath | 切换至指定的场景（异步方法） |
| setSceneIndex | 切换至当前场景目录下的指定场景 |
| putScenes | 在指定场景目录下插入多个场景 |
| moveScene | 移动场景 |
| removeScenes | 删除场景或者场景目录 |
| cleanScene | 清除当前场景的所有内容 |
| pptNextStep | 播放动态 PPT 下一页 |
| pptPreviousStep | 返回动态 PPT 上一页 |
| getScenePathType | 查询场景路径类型 |
| getEntireScenes | 获取当前房间内所有场景的信息 |
| getScenePreviewImage | 获取指定场景的预览图 |
| getSceneSnapshotImage | 获取指定场景的截图 |
| getLocalSnapShotWithCompletion | 获取指定场景的截图 |
回放管理
| 方法 | 描述 |
|---|---|
| play | 开始白板回放 |
| pause | 暂停白板回放 |
| stop | 停止白板回放 |
| seekToScheduleTime | 设置白板回放的播放位置 |
| setObserverMode | 设置白板回放的查看模式 |
| playbackSpeed | 获取白板回放的倍速（同步方法） |
| getPlaybackSpeed | 获取白板回放的倍速（异步方法） |
| phase | 获取白板回放的阶段（同步方法） |
| getPhaseWithResult | 获取白板回放的阶段（异步方法） |
| state | 获取白板回放的状态（同步方法） |
| getPlayerStateWithResult | 获取白板回放的状态（异步方法） |
| timeInfo | 获取白板回放的时间信息（同步方法） |
| getPlayerTimeInfoWithResult | 获取白板回放的时间信息（异步方法） |
自定义事件
| 事件 | 描述 |
|---|---|
| dispatchMagixEvent | 发送自定义事件 |
| addMagixEventListener | 注册自定义事件监听 |
| addHighFrequencyEventListener | 注册高频自定义事件监听 |
| removeMagixEventListener | 移除自定义事件监听 |
iframe 插件交互
| 方法 | 描述 |
|---|---|
| postIframeMessage | 向 iframe 插件发送 key-value 格式的信息 |
其他方法
| 方法 | 描述 |
|---|---|
| debugInfo | 获取调试日志信息 |
| requestSlideLogToFilePath | 获取调试日志信息 |
| setTimeDelay | 设置远端白板画面同步延时。 |
| convertToPointInWorld | 转换白板上点的坐标 |
| refreshViewSize | 刷新白板的界面 |
| nativeWebSocket | 开启/关闭全链路加速 |
| setDrawOnlyApplePencil | （仅适用于 iPad）设置是否只允许用户使用 Apple Pencil 在白板上绘制和书写 |
Copyright © 2025 Agora. All rights reserved. Updated: 2025-04-07
Generated by appledoc 2.2.1 (build 1334).