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

概览

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

首次发布时间2022.11.21 13:14:37

IWhiteBoardRoomManager

方法描述
getSdkVersion获得当前 SDK 版本号。
init白板 SDK 初始化。
joinRoom创建白板实例并加入白板房间。
destroy销毁 IWhiteBoardRoomManager 对象,释放资源。

IWhiteBoardRoom

方法描述
getRoomId获得当前白板房间 ID。
getRoomStatus获取房间状态。
leaveRoom退出白板房间。
destroyRoom关闭房间内所有白板,重进房间后无法进行写画。
switchWhiteBoard指定当前白板。在对白板进行编辑等操作前,需要将该白板设置为当前白板。
removeWhiteBoard关闭指定白板。
getCurrentWhiteBoard获取当前的白板实例。
getCurrentWhiteBoardId获取当前的白板 ID。
getAllWhiteBoardInfo获取房间内所有白板的信息。
createWhiteBoard在房间内创建一个白板。
createFileWhiteBoard在房间内创建 PPT 白板
getWhiteBoardInfo通过白板 ID 获取白板信息。
createTranscodeTask创建一个转码任务。
startPlayback开始播放白板录像。
pausePlayback暂停播放录像。
stopPlayback停止播放录像。
setPlaybackProgress设置白板回放进度。

IWhiteBoard

方法描述
setViewMode设置白板视图跟随模式。
getViewMode获取视图模式。
removePages按照指定的索引号,删除白板页。
zoomIn以当前视图中心为中心点放大白板视图。
zoomOut以当前视图中心为中心点缩小白板视图。
zoomTo按照指定中心点和缩放系数缩放白板视图。
resetZoom恢复默认缩放视图。还原到原始大小,视图中心点恢复为白板中心点。
getZoomFactor获取当前白板视图缩放系数。
setMaxZoom设置白板视图最大放大系数。
exportSnapshot将当前白板中指定页面保存为一张本地图片
getWhiteBoardId获取当前的白板 ID。
getWhiteBoardRoomId获取当前白板所在的房间 ID。
setWritable设置当前白板是否可以编辑。
getWritable获取当前白板是否可以编辑。
setEditType设置编辑动作类型。
getEditType获取当前编辑动作类型。
setBoardBackground修改当前白板的背景设置,例如背景图片颜色等。
addImage在当前页面中添加图片。
addVideo在当前页面中添加视频,只支持 mp4 格式。
addAudio在当前页面中添加音频,只支持 mp3 格式。
setSelectionBoxStyle设置选择框样式。如果默认的选择框样式无法满足你的需求,调用本接口,并传入需要修改的属性。
setShapeSize设置图形线条尺寸。
setShapeColor设置图形颜色。
setPenSize设置画笔尺寸。
setPenColor设置画笔颜色。
setTextColor设置文字颜色。
setTextFontSize设置文本字号大小。
redo重做本端对白板的编辑操作。
undo撤销本端对白板的编辑操作。
createPages创建多个白板页面。在使用文档转码功能后,可以调用本接口,将生成的多个图片批量插入到多个新的白板页面中。
clearPage清空白板。删除当前白板页面上所有的笔迹元素和已插入的图片。
setPageBackground修改当前白板页面的背景设置,例如背景图片颜色等。
flipPage白板翻页。
flipNextPage白板翻到下一页。
flipPrevPage白板翻到上一页。
getAllPageInfo获取所有页面信息。
getCurrentPageId获取当前页面的 PageId。
getCurrentPageInfo获取当前页面信息。
getCurrentPageIndex获取当前页面索引。
getPageCount获取当前页面总数。
getPageInfoByIndex通过索引号获取白板页信息。
enableCursorSync开启光标同步。开启后,房间中其他用户可以看到当前用户光标的实时移动轨迹。默认关闭。
setCursorStyle自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求,调用本接口,为不同工具过指定光标图形和样式。
getPptInfo获取当前 PPT 信息
pptNextStep下一个 PPT 动画,如果是最后一个动画,翻到下一页
pptPrevStep上一个 PPT 动画,如果是第一个动画,翻到上一页

IWhiteBoardRoomEvents

方法描述
onError当内部发生错误信息时回调该事件
onPlaybackStateChanged当白板录像播放状态发生改变时触发此回调
onPlaybackProgressUpdate白板录像播放进度回调。 调用 start 后触发本回调 200 ms 一次。
onPlaybackDataLoaded录像加载成功回调
onCreateWhiteBoard白板创建回调。调用 createWhiteBoard 成功创建白板后,房间内所有用户收到本回调。
onConnectionStateChangedSDK 与信令服务器连接状态回调。当 SDK 与信令服务器的网络连接状态改变时触发。
onCurrentWhiteBoardChanged当前白板被更换时,房间内其他用户收到本回调。
onRemoveWhiteBoard白板被删除时,房间内其他用户收到本回调。

IWhiteBoardEvents

方法描述
onBoardBackgroundChanged修改白板默认背景回调。
onBoardLock当白板锁定状态发生改变时,将触发该回调。
onCreatePagesProgress已创建一个新页面回调。
onRemovePages删除页面回调。
onClearPage白板清空回调。
onPageIndexChanged当前页发生改变时触发此回调,例如,翻页或删除操作。监听本回调及时更新 UI 画面。
onPageCountChanged总页数发生改变时触发此回调,例如,创建新页面或删除操作。监听本回调及时更新 UI 画面。
onPageBackgroundChanged页面背景信息修改时触发该回调。
onRecordUpdated白板操作记录堆栈变化回调。
onError错误回调。
onImageLoading加载图片时触发,包含背景图片和白板页中的图片元素,例如设置背景图片和切换白板时。
onZoomInfoChanged本端成功调用视图缩放接口时触发本回调。
onPptStepChangedPPT 当前动画步数改变时触发本回调。任何与 PPT 动画步数相关事件发生时,都会触发本回调。