mgtv.joinVoIPChat(Object object)
框架版本 0.4.15 开始支持。
加入 (创建) 实时语音通话,调用前需要用户授权 scope.record,若房间类型为视频房间需要用户授权 scope.camera。
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|
roomType | string | voice | 否 | 房间类型因。 |
groupId | string | | 是 | 群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 |
muteConfig | object | | 否 | 静音设置 |
token | string | | 是 | 凭证 |
success | function | | 否 | 接口调用成功的回调函数 |
fail | function | | 否 | 接口调用失败的回调函数 |
complete | function | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.roomType 的合法值
值 | 说明 |
---|
voice | 音频房间,用于语音通话 |
video | 视频房间 |
object.muteConfig 的结构
属性 | 类型 | 默认值 | 必填 | 说明 |
---|
muteMicrophone | boolean | false | 否 | 是否静音麦克风 |
muteEarphone | boolean | false | 否 | 是否静音耳机 |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|
openIdList | array[string] | 在此通话中的成员 Id 名单 |
errMsg | string | 调用结果 |