You need to enable JavaScript to run this app.
导航

概览

最近更新时间2023.10.20 17:59:47

首次发布时间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清除页面。
removePages批量删除白板页。
flipPage白板翻页。
flipNextPage翻到下一页。
@note 调用成功后在房间内所有客户端触发 onPageIndexChanged
flipPrevPage翻到上一页。
@note 调用成功后在房间内所有客户端触发 onPageIndexChanged
getCurrentPageInfo获取当前页面信息。
getAllPageInfo获取所有页面信息。
getCurrentPageId获取当前页面的 PageId。
getCurrentPageIndex获取当前页面索引。
getPageCount获取白板总页数。
getPageInfoByIndex通过索引号获取白板页信息。
setPageBackground修改当前页面的背景图、背景色。

PPT 相关

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

视图相关

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

编辑

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

播放白板录制

方法描述
startPlayback开始播放白板录像。

成功调用后,触发 onPlaybackStateChanged 播放状态回调。
pausePlayback暂停播放白板录像。

成功调用后,触发 onPlaybackStateChanged 播放状态回调。
stopPlayback停止播放白板录像。

成功调用后,触发 onPlaybackStateChanged 播放状态回调。
setPlaybackProgress设置白板回放进度。
回调

白板 SDK 管理

回调描述
onConnectionStateChanged回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。
onSuccess方法调用成功
onError方法调用失败

白板房间管理

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

白板管理

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

页面管理

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

PPT 相关

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

视图相关

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

编辑

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

播放白板录制

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