文档中心

概览

最近更新时间：2024.03.28 10:38:19

首次发布时间：2022.12.05 21:56:56

方法

白板 SDK 管理

方法	描述
getSdkVersion	获取白板 SDK 版本号。静态方法，无需创建白板实例。
setLogLocation	设置日志路径。
setDeviceID	设置设备 ID。
getView	获取当前白板视图。
create	创建和初始化白板 WhiteBoardRoomManager 实例。
destroy	销毁 whiteBoardRoomManager 实例，释放资源。

白板房间管理

方法	描述
joinRoom	加入白板房间。
destroyWhiteBoardRoom	销毁白板房间实例。
getWhiteBoardRoom	获取白板实例。创建多个房间后，可以通过调用接口获得相应实例。
getWhiteBoardRoomId	获取当前白板所在的房间 ID。
getRoomID	获取房间 ID。
getRoomStatus	获取房间状态。
leaveRoom	退房。
destroyRoom	关闭所有白板，重进房间后无法进行写画。

白板管理

方法	描述
createWhiteBoard	在房间内创建一个白板。
createFileWhiteBoard	在房间内创建一个 PPT 白板，用于本端发起一个 PPT。
removeWhiteBoard	关闭指定白板。
switchWhiteBoard	指定当前白板。在对白板进行编辑等操作前，需要将该白板设置为当前白板。
getWhiteBoard	通过白板 ID 获取白板对象。
getCurrentWhiteBoard	获取当前白板对象。
getCurrentWhiteBoardID	获取当前的白板 ID。
getWhiteBoardInfo	通过白板 ID 获取白板信息。
getAllWhiteBoardInfo	获取所有白板信息。
getWhiteBoardId	获取当前白板 ID。
setBoardBackground	修改当前白板的背景设置，例如背景图片颜色等。
setWritable	设置当前白板是否可以编辑。
setEventHandler	设置白板事件回调。

页面管理

方法	描述
createPages	新建多个白板页。
clearPage	清除页面。
exportSnapshot	将当前白板中指定页面保存为一张本地图片。
removePages	批量删除白板页。
flipPage	白板翻页。
flipNextPage	翻到下一页。
flipPrevPage	翻到上一页。
getCurrentPageInfo	获取当前页面信息。
getAllPageInfo	获取所有页面信息。
getCurrentPageId	获取当前页面的 PageId。
getCurrentPageIndex	获取当前页面索引。
getPageCount	获取白板总页数。
getPageInfoByIndex	通过索引号获取白板页信息。
setPageBackground	修改当前页面的背景图、背景色。

PPT 相关

方法	描述
getPptInfo	获取当前 PPT 信息，非 PPT 白板返回空
pptNextStep	下一个 PPT 动画，如果是最后一个动画，翻到下一页
pptPrevStep	上一个 PPT 动画，如果是第一个动画，翻到上一页

视图相关

方法	描述
setViewMode	设置白板视角同步方式。
setZoomOperation	设置手势缩放拖拽。
getViewMode	获取视图模式。
setMaxZoom	设置白板视图最大放大系数。
zoomIn	按照当前中心点和缩放系数放大白板视图。
zoomOut	按照当前中心点和缩放系数缩小白板视图。
zoomTo	按照指定中心点和缩放系数缩放白板视图。
resetZoom	恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。
getZoomFactor	获取当前白板视图缩放系数。

编辑

方法	描述
setEditType	设置编辑动作类型。
setPenSize	设置笔画笔迹宽度。
addAudio	在当前页面中添加音频，只支持 mp3 格式。
addVideo	在当前页面中添加视频，只支持 mp4 格式。
setPenColor	设置笔画颜色。
setShapeSize	设置形状线条宽度。
setShapeColor	设置形状颜色。
setTextFontSize	设置文本字号大小。
setTextColor	设置文字颜色。
setSelectionBoxStyle	设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。默认样式详见 ShapeStyle。
enableCursorSync	开启光标同步功能，默认关闭。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。
setCursorStyle	自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。
undo	撤销本端对白板的编辑操作。
redo	重做本端对白板的编辑操作。
addImage	在当前页面中添加图片。

播放白板录制

方法	描述
startPlayback	开始播放白板录像。成功调用后，触发 onPlaybackStateChanged 播放状态回调。
pausePlayback	暂停播放白板录像。成功调用后，触发 onPlaybackStateChanged 播放状态回调。
stopPlayback	停止播放白板录像。成功调用后，触发 onPlaybackStateChanged 播放状态回调。
setPlaybackProgress	设置白板回放进度。

回调

白板 SDK 管理

回调	描述
onConnectionStateChanged	回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。

白板房间管理

回调	描述
onError	当内部发生错误信息时回调该事件。

白板管理

回调	描述
onError	当内部发生错误信息时回调该事件。
onCreateWhiteBoard	白板创建回调。
onBoardLock	当白板锁定状态发生改变时，将触发该回调。
onBoardBackgroundChanged	白板背景信息被修改时触发该回调。
onRemoveWhiteBoard	白板被删除时，房间内其他用户收到本回调。
onCurrentWhiteBoardChanged	当前白板切换时，房间内其他用户收到本回调。

页面管理

回调	描述
onClearPage	白板清空回调。调用 clearPage 后，房间中所有用户将收到本回调。
onCreatePagesProgress	已创建一个新页面回调。
onPageCountChanged	总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调及时更新 UI 画面。
onRemovePages	已删除页面回调。
onPageBackgroundChanged	页面背景信息被修改时触发该回调。
onExportSnapshot	保存当前页的快照。
onPageIndexChanged	当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调及时更新 UI 画面。

PPT 相关

回调	描述
onPptStepChanged	PPT 当前动画步数改变。任何与 PPT 动画步数相关事件发生时，都会触发本回调。

视图相关

回调	描述
onZoomInfoChanged	当前白板的缩放信息改变时通知，以便更新 UI。

编辑

回调	描述
onCanUndoStateChanged	可撤销状态改变的回调。
onCanRedoStateChanged	可重做状态改变的回调。
onImageLoading	加载画面回调。

播放白板录制

回调	描述
onPlaybackDataLoaded	回放录像加载成功回调。
onPlaybackStateChanged	当白板录像播放状态发生改变时触发此回调。
onPlaybackProgressUpdate	白板录像播放进度回调。调用 startPlayback 后触发本回调 200 ms 一次。

方法

白板 SDK 管理

白板房间管理

白板管理

页面管理

PPT 相关

视图相关

编辑

播放白板录制

回调

白板 SDK 管理

白板房间管理

白板管理

页面管理

PPT 相关

视图相关

编辑

播放白板录制