Members
-
<static, readonly> HANGUP_*
-
通话挂断对方的退出方式
- WhiteBoard.HANGUP_TYPE_NORMAL 正常挂断
- WhiteBoard.HANGUP_TYPE_TIMEOUT 超时挂断
-
<static, readonly> WB_CONTROL_COMMAND_*
-
控制指令
- WhiteBoard.CONTROL_COMMAND_BUSY 占线
- WhiteBoard.CONTROL_COMMAND_SELF_ON_BACKGROUND 自己处于后台
- WhiteBoard.CONTROL_COMMAND_START_NOTIFY_RECEIVED 告诉发送方自己已经收到请求了(用于通知发送方开始播放提示音)
-
<static, readonly> WB_TYPE_*
-
音视频通话类型
- WhiteBoard.WB_TYPE_TCP TCP通道白板
- WhiteBoard.WB_TYPE_UDP UDP通道白板
Methods
-
<static> getInstance(options)
-
Parameters:
Name Type Description options
Object 配置参数
Properties
Name Type Argument Default Description nim
NIM NIM 实例
isCustom
Node <optional>
true 是否走上层自己解析
container
Node <optional>
canvas容器
debug
Boolean <optional>
false 是否开启debug模式,默认不开启,debug模式下浏览器会打印log日志
-
call(options)
-
发起白板呼叫
Parameters:
Name Type Description options
Object 配置参数
Properties
Name Type Argument Description type
Number netcallType
Boolean 音视频类型
, 默认值:0account
String 对方账号
pushConfig
Object <optional>
推送配置
Properties
Name Type Argument Default Description enable
Boolean <optional>
true 是否需要推送, 默认 true
needBadge
Boolean <optional>
true 是否需要角标计数, 默认 true
needPushNick
Boolean <optional>
true 是否需要推送昵称, 默认 true
pushContent
String <optional>
推送内容
custom
String <optional>
自定义通知数据
pushPayload
String <optional>
JSON格式的推送 payload
sound
String <optional>
推送声音
sessionConfig
Object <optional>
会话配置
Properties
Name Type Argument Default Description width
Number <optional>
宽度
height
Number <optional>
高度
record
Boolean <optional>
false 服务端白板录制开关,默认关闭
Returns:
- Type
- Void
-
control(options)
-
发送音视频通话控制指令
Parameters:
Name Type Default Description options
Object {} 配置参数
Properties
Name Type Argument Description channelId
String <optional>
要发送指令的通话的 channelId, 如果不填那么默认为当前通话
command
Number <optional>
可选控制指令请参考
WhiteBoard.NETCALL_CONTROL_COMMAND_*
info
String <optional>
命令信息
Returns:
- Type
- Void
-
createChannel(options)
-
创建频道
Parameters:
Name Type Description options
Object 配置参数
Properties
Name Type Description channelName
Number 频道名称
custom
String 扩展字端(用于上层放自定义数据,选填)
Returns:
- Type
- Promise
-
destroy()
-
销毁白板
Returns:
- Type
- Void
-
getAccount()
-
获取当前登录的 IM 账号
Returns:
- Type
- String
-
getStatus()
-
获取当前白板实例的状态信息
Returns:
- Type
- Object
-
getUid()
-
获取当前登录的IM账号的 uid
Returns:
- Type
- String
-
hangup( [channelId])
-
挂断白板通话
Parameters:
Name Type Argument Description channelId
String <optional>
要挂断的通话的 channelId, 如果不填那么挂断当前通话
Returns:
- Type
- Void
-
isChannelConnected()
-
判断白板通道是否已连接,v5.6.0 新增接口
-
isCurrentChannelId()
-
是否是当前会话的 channelId
Returns:
- Type
- Boolean
-
isCurrentChannelId()
-
不是当前会话的 channelId
Returns:
- Type
- Boolean
-
joinChannel(options)
-
主动加入频道
Parameters:
Name Type Argument Description options
Object 白板相关配置参数
option.role
num 用户角色, 默认互动者
options.channelName
String 频道名称
option.sessionConfig
Object 配置参数
options.sessionConfig.backgroundUrl
String <optional>
默认背景图(切换PPT的时候展示)
options.sessionConfig.color
String <optional>
画笔颜色
options.sessionConfig.width
Number <optional>
宽度
options.sessionConfig.height
Number <optional>
高度
option.sessionConfig.record
num <optional>
是否录制
Returns:
- Type
- Promise
-
leaveChannel()
-
离开房间
Returns:
- Type
- Void
-
response( [options])
-
响应呼叫
Parameters:
Name Type Argument Default Description options
Object <optional>
{} 配置参数
Properties
Name Type Argument Default Description accepted
Boolean <optional>
true true 接听, false 拒绝
beCalledInfo
Object 被呼叫的信息, 在 beCalling 事件里可以接收到的信息
sessionConfig
Object <optional>
会话配置
Properties
Name Type Argument Default Description width
Number <optional>
宽度
height
Number <optional>
高度
record
Boolean <optional>
false 服务端白板录制开关,默认关闭
Returns:
- Type
- Promise
-
sendData(data, toAccount)
-
发送自定义数据 v5.0.2 新增接口
Parameters:
Name Type Description data
any 数据
toAccount
optional 目标用户
-
startSession()
-
开启会话连接
Returns:
- Type
- Void
-
stopSession()
-
结束会话连接
Returns:
- Type
- Void