互动白板SDK

云信互动白板基于云信实时通信网络，提供完整的多人实时白板互动服务。同时，搭配云信实时音视频、IM即时通讯产品，借助互动白板的互动涂鸦、实时同步、文档共享、录制回放等功能，真正满足在线教育、金融面签、视频会议等低延时高互动场景需求。

完整的互动白板SDK 由 WhiteBoardSDK, DrawPlugin, ToolCollection与 RecordPlayer 四部分组成。

• WhiteBoardSDK 调用getInstance后，返回 WhiteBoardSDKInstance 实例
• DrawPlugin 调用 whiteboardSDKInstance.joinRoom后， then回调中返回 DrawPlugin 实例
• ToolCollection 调用getInstance后，返回 ToolCollectionInstance 实例
• RecordPlayer 调用getInstance后，Promise.then 中返回 RecordPlayerInstance 实例
• WhiteBoardSDKInstance 是SDK实例。建立实例后，可以执行创建房间，退出房间等操作
• ToolCollectionInstance 是工具栏对象，负责渲染白板工具栏，并通过工具栏操作白板
• RecordPlayerInstance 是录像回放对象，负责加载录像文件，并回放白板上课的内容

WhiteBoard 对象

方法	功能描述
WhiteBoardSDK.getInstance	创建教学房间sdk对象
WhiteBoardSDKInstance.joinRoom	加入房间
WhiteBoardSDKInstance.destroy	离开房间，销毁sdk对象
WhiteBoardSDKInstance.getUid	获取当前sdk的uid
WhiteBoardSDKInstance.getChannelId	获取当前sdk的cid
WhiteBoardSDKInstance.isConnected	获取当前sdk是否连接
WhiteBoardSDKInstance.isSynchronizing	获取当前sdk是否同步中

Toast操作

方法	功能描述
WhiteBoardSDK.showToast	显示Toast
WhiteBoardSDK.hideToast	隐藏Toast
WhiteBoardSDK.interceptShowToast	拦截Toast显示请求
WhiteBoardSDK.removeToastIntercept	使之前设置的拦截请求无效

DrawPlugin基本操作

方法	功能描述
DrawPlugin.enableDraw	设置可否编辑
DrawPlugin.setAppConfig	设置属性
DrawPlugin.setFontFamilies	设置字体
DrawPlugin.setShowCursor	设置广播鼠标位置

画布操作

方法	功能描述
DrawPlugin.clear	清空画布
DrawPlugin.undo	撤销
DrawPlugin.redo	重做
DrawPlugin.duplicate	复制元素
DrawPlugin.setTool	设置教具
DrawPlugin.setStrokeColor	设置涂鸦、图形或者连接的颜色
DrawPlugin.setStrokeWidth	设置涂鸦、图形或者连接的粗细

DrawPlugin文档操作

方法	功能描述
DrawPlugin.addDoc	添加静态文档
DrawPlugin.addTransDoc	添加动态文档
DrawPlugin.addBoard	添加空白文档
DrawPlugin.gotoBoard	切换文档
DrawPlugin.deleteBoard	删除文档
DrawPlugin.getBoardInfos	获取文档信息
DrawPlugin.hasTransDoc	是否为动态文档
DrawPlugin.exportBoards	将白板内容导出为文件
DrawPlugin.importBoards	导入导出的白板内容

DrawPlugin页面操作

方法	功能描述
DrawPlugin.addPage	添加页面
DrawPlugin.gotoPage	切换页面
DrawPlugin.gotoFirstPage	跳至第一页面
DrawPlugin.gotoLastPage	跳至最后一页
DrawPlugin.gotoNextPage	跳至下一页
DrawPlugin.gotoPrevPage	跳至上一页
DrawPlugin.nextAnim	播放下一个动画
DrawPlugin.prevAnim	播放上一个动画
DrawPlugin.gotoAnim	跳转至指定动画位置
DrawPlugin.deletePage	删除页面
DrawPlugin.getPageInfos	获取页面信息
DrawPlugin.getAnimInfos	获取动画信息
DrawPlugin.hasBackground	页面是否有背景图

DrawPlugin视角操作

方法	功能描述
DrawPlugin.fitToContent	适配内容
DrawPlugin.fitToDoc	适配文档
DrawPlugin.setCameraBound	设置视角
DrawPlugin.zoomIn	缩放
DrawPlugin.zoomOut	缩放
DrawPlugin.zoomTo	缩放
DrawPlugin.resetCamera	重置视角
DrawPlugin.setSelfAsBroadcaster	广播视角
DrawPlugin.unsetSelfAsBroadcaster	停止广播
DrawPlugin.setSelfAsFollower	设置视角跟随
DrawPlugin.setSelfAsFreeObserver	解除视角跟随

DrawPlugin媒体操作

方法	功能描述
DrawPlugin.addImage	添加图片
DrawPlugin.addVideo	添加视频
DrawPlugin.setPageBackground	设置页面背景
DrawPlugin.exportAsBase64String	导出画布
DrawPlugin.exportAsImage	导出画布

DrawPlugin自定义背景

方法	功能描述
DrawPlugin.setCustomBackground	设置自定义背景
DrawPlugin.unsetCustomBackground	取消自定义背景
DrawPlugin.getBgRendererName	获取当前自定义背景名称

DrawPlugin流操作

方法	功能描述
DrawPlugin.getStream	获取白板流
DrawPlugin.updateStream	更新白板流分辨率
DrawPlugin.stopStream	停止白板流

工具栏主流程

方法	功能描述
ToolCollection.getInstance	创建工具栏对象
ToolCollectionInstance.show	显示工具栏
ToolCollectionInstance.hide	隐藏工具栏

工具栏图标控制

方法	功能描述
ToolCollectionInstance.setContainerOptions	一次性配置工具栏图标
ToolCollectionInstance.addOrSetTool	动态添加工具栏图标
ToolCollectionInstance.removeTool	动态移除工具栏图标
ToolCollectionInstance.addOrSetSubItem	动态移除工具栏子图标
ToolCollectionInstance.removeSubItem	动态移除工具栏子图标
ToolCollectionInstance.setVisibility	配置工具栏部分可见性

文档弹窗

方法	功能描述
ToolCollectionInstance.setDefaultDocList	设置文档弹窗默认列表
ToolCollectionInstance.addDoc	添加转码文件
ToolCollectionInstance.deleteDoc	移除转码文件

工具栏事件

方法	功能描述
ToolCollectionInstance.on	注册工具栏事件回调
ToolCollectionInstance.off	注销工具栏事件回调

录像回放

方法	功能描述
RecordPlayer.getInstance	创建录像回放对象
RecordPlayerInstance.bindControlContainer	使用sdk内置的播放器控制UI
RecordPlayerInstance.setPlaySpeed	设置播放速度
RecordPlayerInstance.setViewer	设置观看视角
RecordPlayerInstance.setTimeRange	自定义播放的起始结束时间
RecordPlayerInstance.play	播放录像
RecordPlayerInstance.pause	暂停录像
RecordPlayerInstance.seekTo	跳转录像
RecordPlayerInstance.destroy	销毁录像回放对象
RecordPlayerInstance.on	录像回放回调注册