集成方式
目前点对点白板支持音频通话，需要依赖音视频插件，详情请见音视频集成方式
SDK集成方式
互动白板依赖IM账号体系，所以需要首先下载 NIM SDK
下载SDK
官网 SDK 下载入口。
目录结构介绍
- 如果要在浏览器里面使用 SDK, 相应的 JS 文件都在
js目录下.
- 如果要在浏览器里面使用 SDK, 相应的 JS 文件都在
引入SDK
IM功能引入，请引入
NIM_Web_NIM_v.js，通过NIM来获取引用白板功能引入，请引入
NIM_Web_WhiteBoard_v.js，通过WhiteBoard来获取引用：白板绘制插件引入， 请引入
DrawPlugin.js, 通过DrawPlugin来获取引用，请参考这里音频功能引入，请参照这里
总体接口介绍
引入SDK脚本并且实例化之后，得到一个SDK工具集合: whiteboard(自定义变量名)，下面我们大致介绍一下最常用的一些接口作用，具体的参数配置请参照后面具体的API介绍
- 通话控制相关
| 接口名 | 说明 |
|---|---|
| whiteboard.call | 主叫发起互动白板请求 |
| whiteboard.response | 被叫响应白板请求 |
| whiteboard.hangup | 主动结束互动白板 |
| whiteboard.control | 通话过程中发送控制指令: 正忙等详情 |
- 发送数据接口
| 接口名 | 说明 |
|---|---|
| whiteboard.sendData | 发送数据 |
- 事件通知注册与回调相关
| 接口名 | 说明 |
|---|---|
| whiteboard.on('beCalling', obj => {}) | 收到白板呼叫通知 |
| whiteboard.on('callAccepted', obj => {}) | 主叫收到被叫应答通知: 接受 |
| whiteboard.on('callRejected', obj => {}) | 主叫收到被叫应答通知: 拒绝 |
| whiteboard.on('control', obj => {}) | 白板进行中收到对端的控制通知 |
| whiteboard.on('hangup', obj => {}) | 收到白板结束的通知 |
| whiteboard.on('callerAckSync', obj => {}) | 其他端已处理的通知 |
| whiteboard.on('data', obj => {}) | 监听接收自定义裸数据 |
本篇文档内容是否对您有帮助？
有帮助
我要吐槽
此文档对你是否有帮助
×
有帮助
我要吐槽
×
反馈成功
非常感谢您的反馈，我们会继续努力做得更好。