2023年微信小程序API 实时语音·加入(创建)实时语音通话
作者: --时间: 2022-09-29
阅读量:
加入(创建)微信小程序实时语音通话,是一项支持语音和视频房间的功能。通过调用 wx.joinVoIPChat(Object object) 接口,可以实现进入语音房间或者视频房间,从而展开实时语音通话。
下面是该接口的详细参数说明:
其中,roomType 是房间类型,可选值有 "voice" 和 "video" 两种。另外,必须授权 scope.record 才能调用该接口。
1. Object object
这是一个对象类型的参数,包含以下几个属性:| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| roomType | String | voice | 否 | 房间类型 |
| signature | String | 是 | 签名,用于验证小游戏的身份 | |
| nonceStr | String | 是 | 验证所需的随机字符串 | |
| timeStamp | Number | 是 | 验证所需的时间戳 | |
| groupId | String | 是 | 小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 | |
| muteConfig | Object | 否 | 静音设置 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
2. object.muteConfig
这是一个对象类型的参数,包含以下两个属性:| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| muteMicrophone | Boolean | false | 否 | 是否静音麦克风 |
| muteEarphone | Boolean | false | 否 | 是否静音耳机 |

