微信小程序API 实时语音·加入(创建)实时语音通话
2020-07-23 11:14 更新
wx.joinVoIPChat(Object object)
基础库 2.7.0 开始支持，低版本需做兼容处理。
调用前需要 用户授权 scope.record
加入 (创建) 实时语音通话，更多信息可见 实时语音指南
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| roomType | String | voice | 否 | 房间类型 |
| signature | String | 是 | 签名，用于验证小游戏的身份 | |
| nonceStr | String | 是 | 验证所需的随机字符串 | |
| timeStamp | Number | 是 | 验证所需的时间戳 | |
| groupId | String | 是 | 小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 | |
| muteConfig | Object | 否 | 静音设置 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
object.roomType 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| voice | 音频房间，用于语音通话 | |
| video | 视频房间，结合 voip-room 组件可显示成员画面 |
object.muteConfig 的结构
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| muteMicrophone | Boolean | false | 否 | 是否静音麦克风 |
| muteEarphone | Boolean | false | 否 | 是否静音耳机 |
object.success 回调函数
参数
Object res
| 属性 | 类型 | 说明 |
|---|---|---|
| openIdList | Array.<String> | 在此通话中的成员 openId 名单 |
| errCode | Number | 错误码 |
| errMsg | String | 调用结果 |
错误
| 错误码 | 错误信息 | 说明 |
|---|---|---|
| -1 | 当前已在房间内 | |
| -2 | 录音设备被占用，可能是当前正在使用微信内语音通话或系统通话 | |
| -3 | 加入会话期间退出（可能是用户主动退出，或者退后台、来电等原因），因此加入失败 | |
| -1000 | 系统错误 |
以上内容是否对您有帮助：
更多建议：