实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频互动白板客户端 API 参考iOS概览
概览
文档反馈
问问助手方法
白板 SDK 管理
| 方法 | 描述 |
|---|---|
| getSdkVersion | 获取白板 SDK 版本号。 |
| setLogLocation: | 设置本地日志缓存路径。 |
| setDeviceID: | 设置设备 ID。 |
| getView | 获取当前白板视图。 |
| sharedEngineWithAppId:bindToWindow:completionHandler: | 创建和初始化白板 ByteWhiteBoardRoomManager 实例。 |
| destroy | 销毁 ByteWhiteBoardRoomManager 实例，释放资源。 |
白板房间管理
| 方法 | 描述 |
|---|---|
| joinRoom:userID:token:defalutBoard:completionHandler:delegate: | 加入白板房间。 |
| getWhiteBoardRoomId: | 获取当前白板所在的房间 ID。 |
| getRoomId: | 获得当前白板房间 ID。 |
| getRoomStatus: | 获取房间状态。 |
| leaveRoom | 退房。 |
| destroyRoom | 关闭所有白板，重进房间后无法进行写画。 |
| updateByteWhiteBoardRoomDelegate: | 更新 ByteWhiteBoardRoomDelegate 回调手柄。 |
白板管理
| 方法 | 描述 |
|---|---|
| createWhiteBoard:pageInfo:backgroundInfo:boardName: | 在房间内创建一个白板。 |
| createFileWhiteBoard:boardName:pptInfo: | 在房间内创建一个 PPT 白板 |
| removeWhiteBoard: | 关闭指定白板。 |
| switchWhiteBoard: | 指定当前白板。 |
| getCurrentWhiteBoard: | 获取当前白板对象。 |
| getCurrentWhiteBoardId: | 获取当前的白板 ID。 |
| getWhiteBoardInfo:completionHandler: | 通过白板 ID 获取白板信息。 |
| getAllWhiteBoardInfo: | 获取所有白板信息。 |
| getWhiteBoardId: | 获取当前的白板 ID。 |
| setBoardBackground: | 修改当前白板的背景设置，例如背景图片颜色等。 |
| setWritable: | 设置当前白板是否可以编辑。 |
| updateByteWhiteBoardDelegate: | 设置事件回调。 |
页面管理
| 方法 | 描述 |
|---|---|
| createPages:index:isAutoFlip: | 新建多个白板页。 |
| clearPage | 清除页面。 调用成功后在房间内所有客户端触发 byteWhiteBoard:onClearPage: |
| exportSnapshot:withElements:withBackGround: | 将当前白板中指定页面保存为一张本地图片。 |
| removePages:flip: | 按照指定的索引号，删除白板页。 |
| flipPage: | 白板翻页。 |
| flipNextPage | 白板翻到下一页。 调用成功后在房间内所有客户端触发 byteWhiteBoard:onPageIndexChanged: |
| flipPrevPage | 白板翻到上一页。 调用成功后在房间内所有客户端触发 byteWhiteBoard:onPageIndexChanged: |
| getCurrentPageInfo: | 获取当前页面信息。详见 ByteWhiteBoardPageInfo |
| getAllPageInfo: | 获取所有页面信息。 |
| getCurrentPageId: | 获取当前页面的 PageId。 |
| getCurrentPageIndex: | 获取当前页面索引。 |
| getPagesCount: | 获取白板总页数。 |
| getPageInfoByIndex:completionHandler: | 通过索引号获取白板页信息。 |
| setPageBackground: | 修改当前白板页面的背景设置，例如背景图片颜色等。 |
PPT 相关
| 方法 | 描述 |
|---|---|
| getPptInfo: | 获取当前 PPT 信息，非 PPT 白板返回空 |
| pptNextStep | 下一个 PPT 动画，如果是最后一个动画，翻到下一页 |
| pptPrevStep | 上一个 PPT 动画，如果是第一个动画，翻到上一页 |
视图相关
| 方法 | 描述 |
|---|---|
| setViewMode: | 设置白板视角同步方式。 |
| setZoomOperation: | 设置手势缩放拖拽。 |
| getViewMode: | 获取视图模式。 |
| setMaxZoom: | 设置白板视图最大放大系数。 |
| zoomIn: | 按照当前中心点和缩放系数放大白板视图。 |
| zoomOut: | 按照当前中心点和缩放系数缩小白板视图。 |
| zoomTo:Y:X: | 按照指定中心点和缩放系数缩放白板视图。 |
| resetZoom | 恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。 |
| getZoomFactor: | 获取当前白板视图缩放系数。 |
编辑
| 方法 | 描述 |
|---|---|
| setEditType: | 设置编辑动作类型。 |
| setShapeSize: | 设置形状线条宽度。 |
| setPenSize: | 设置画笔笔迹宽度。 |
| setPenColor: | 设置画笔颜色。 |
| setShapeColor: | 设置图形边框颜色。 |
| setTextFontSize: | 设置文本字号大小。 |
| setTextColor: | 设置文本颜色。 |
| setSelectionBoxStyle: | 设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。默认样式详见 ByteWhiteBoardAnchor。 |
| enableCursorSync: | 开启光标同步功能。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。默认关闭。 |
| setCursorStyle: | 自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。 |
| undo | 撤销本端对白板的编辑操作。 当 byteWhiteBoard:onCanUndoStateChanged: 返回的状态为 false 时，调用本接口无效。 |
| redo | 重做本端对白板的编辑操作。 当 byteWhiteBoard:onCanRedoStateChanged: 返回的状态为 false 时，调用本接口无效。 |
| addImage:rect:completionHandler: | 在当前页面中添加图片。 |
| addVideo:title:completionHandler: | 在当前页面中添加视频，只支持 mp4 格式。 |
| addAudio:title:completionHandler: | 在当前页面中添加音频，只支持 mp3 格式。 |
播放白板录制
| 方法 | 描述 |
|---|---|
| startPlayback | 开始播放白板录像。 成功调用后，触发 byteWhiteBoardRoom:onPlaybackStateChanged:reason: 播放状态回调。 |
| pausePlayback | 暂停播放白板录像。 成功调用后，触发 byteWhiteBoardRoom:onPlaybackStateChanged:reason: 播放状态回调。 |
| stopPlayback | 停止播放白板录像。 成功调用后，触发 byteWhiteBoardRoom:onPlaybackStateChanged:reason: 播放状态回调。 |
| setPlaybackProgress:block: | 设置白板回放进度。 |
回调
白板 SDK 管理
| 回调 | 描述 |
|---|---|
| byteWhiteBoardRoom:onConnectionStateChanged: | SDK 与信令服务器连接状态回调。当 SDK 与信令服务器的网络连接状态改变时触发。 |
白板房间管理
| 回调 | 描述 |
|---|---|
| byteWhiteBoardRoom:onError:message: | 当内部发生错误信息时回调该事件。 |
白板管理
| 回调 | 描述 |
|---|---|
| byteWhiteBoard:onError:message: | 当内部发生不可逆转测错误时回调。 |
| byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:pptInfo: | 白板创建回调。 |
| byteWhiteBoard:onBoardLock:reason: | 当白板锁定状态发生改变时，将触发该回调。 |
| byteWhiteBoard:onBoardBackgroundChanged:boardId:boardBackgroundInfo: | 白板背景信息被修改时触发该回调。 |
| byteWhiteBoardRoom:onRemoveWhiteBoard:boardId:pptInfo: | 白板被删除时，房间内其他用户收到本回调。 |
| byteWhiteBoardRoom:onCurrentWhiteBoardChanged:activeBoard:whiteboard: | 当前白板切换时，房间内其他用户收到本回调。 |
页面管理
| 回调 | 描述 |
|---|---|
| byteWhiteBoard:onClearPage: | 白板清空回调。 调用 clearPage 后，房间中所有用户将收到本回调。 |
| byteWhiteBoard:onCreatePagesProgress:pages:insertPageId:progress:totalCount: | 已创建一个新页面回调。 |
| byteWhiteBoard:onPageCountChanged: | 总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调及时更新 UI 画面。 |
| byteWhiteBoard:onRemovePages:boardId:pages: | 已删除页面回调。 |
| byteWhiteBoard:onPageBackgroundChanged:boardId:pageId:backgroundInfo: | 页面背景信息被修改时触发该回调。 |
| byteWhiteBoard:onExportSnapshot: | 保存当前页的快照。 |
| byteWhiteBoard:onPageIndexChanged: | 当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调及时更新 UI 画面。 |
PPT 相关
| 回调 | 描述 |
|---|---|
| byteWhiteBoard:onPptStepChanged:currentStep:totalStep:currentPageIndex: | PPT 当前动画步数改变。任何与 PPT 动画步数相关事件发生时，都会触发本回调。 |
视图相关
| 回调 | 描述 |
|---|---|
| byteWhiteBoard:onZoomInfoChanged:offstX:offstY: | 当前白板的缩放信息改变时通知，以便更新 UI |
编辑
| 回调 | 描述 |
|---|---|
| byteWhiteBoard:onCanUndoStateChanged: | 可撤销状态改变的回调。 |
| byteWhiteBoard:onCanRedoStateChanged: | 可重做状态改变的回调。 |
| byteWhiteBoard:onImageLoading:pageId:boardId:imageUrl: | 加载画面回调。 |
播放白板录制
| 回调 | 描述 |
|---|---|
| byteWhiteBoardRoom:onPlaybackStateChanged:reason: | 当白板录像播放状态发生改变时触发此回调。 |
| byteWhiteBoardRoom:onPlaybackProgressUpdate:duration: | 白板录像播放进度回调。 调用 startPlayback 后触发本回调 200 ms 一次。 |
| byteWhiteBoardRoom:onPlaybackDataLoaded:finish: | 回放录像加载成功回调。 |
最近更新时间：2024.03.28 10:38:19
这个页面对您有帮助吗？
有用
有用
无用
无用