微信小程序API 实时语音·加入(创建)实时语音通话

2020-07-23 11:14 更新

wx.joinVoIPChat(Object object)

基础库 2.7.0 开始支持,低版本需做兼容处理
调用前需要 用户授权 scope.record

加入 (创建) 实时语音通话,更多信息可见 实时语音指南

参数

Object object

属性类型默认值必填说明
roomTypeStringvoice房间类型
signatureString签名,用于验证小游戏的身份
nonceStrString验证所需的随机字符串
timeStampNumber验证所需的时间戳
groupIdString小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。
muteConfigObject静音设置
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.roomType 的合法值

说明最低版本
voice音频房间,用于语音通话
video视频房间,结合 voip-room 组件可显示成员画面

object.muteConfig 的结构

属性类型默认值必填说明
muteMicrophoneBooleanfalse是否静音麦克风
muteEarphoneBooleanfalse是否静音耳机

object.success 回调函数

参数
Object res
属性类型说明
openIdListArray.<String>在此通话中的成员 openId 名单
errCodeNumber错误码
errMsgString调用结果

错误

错误码错误信息说明
-1当前已在房间内
-2录音设备被占用,可能是当前正在使用微信内语音通话或系统通话
-3加入会话期间退出(可能是用户主动退出,或者退后台、来电等原因),因此加入失败
-1000系统错误


以上内容是否对您有帮助:
前端课程
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号

意见反馈
返回顶部