概览--实时音视频-火山引擎

文档中心

导航

概览

最近更新时间：2023.09.15 18:44:35首次发布时间：2023.08.07 20:50:14

IWhiteBoardRoomManager

方法	描述
getSdkVersion	获得当前 SDK 版本号。
init	白板 SDK 初始化。
joinRoom	创建白板实例并加入白板房间。

IWhiteBoardRoom

方法	描述
leaveRoom	退出白板房间。
getCurrentWhiteBoard	获取当前的白板实例。
createWhiteBoard	在房间内创建一个白板。
switchWhiteBoard	通过白板 ID 指定当前白板。在对白板进行编辑等操作前，需要将该白板设置为当前白板。
getWhiteBoardInfo	通过白板 ID 获取白板信息。
getAllWhiteBoardInfo	获取房间内所有白板的信息。
createTranscodeTask	创建一个转码任务。

IWhiteBoard

方法	描述
getWhiteBoardId	获取当前的白板 ID。
createPages	创建多个白板页面。在使用文档转码功能后，可以调用本接口，将生成的多个图片批量插入到多个新的白板页面中。
flipPage	通过页面索引指定白板当前页。
flipNextPage	白板翻到下一页。
flipPrevPage	白板翻到上一页。
getAllPageInfo	获取所有页面信息。
getCurrentPageIndex	获取当前页面索引。
getPageCount	获取当前页面总数。

IWhiteBoardRoomEvents

方法	描述
onError	错误回调。
onCreateWhiteBoard	白板创建回调。调用 createWhiteBoard 成功创建白板后，房间内所有用户收到本回调。
onCurrentWhiteBoardChanged	当前白板被更换时，房间内其他用户收到本回调。
onRemoveWhiteBoard	白板被删除时，房间内其他用户收到本回调。

IWhiteBoardEvents

方法	描述
onError	错误回调。
onCreatePagesProgress	已创建一个新页面回调。
onPageIndexChanged	当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调及时更新 UI 画面。
onPageCountChanged	总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调及时更新 UI 画面。
onImageLoading	加载图片时触发，包含背景图片元素，例如设置背景图片和切换白板时。