Skip to main content
Version: 下个版本

Taro.joinVoIPChat(option)

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

调用前需要用户授权 scope.record,若房间类型为视频房间需要用户授权 scope.camera

支持情况:

参考文档

类型

(option: Option) => Promise<Promised>

参数

参数类型
optionOption

Promised

FailCallbackResult | SuccessCallbackResult

Option

参数类型默认值必填说明
roomTypeRoomType"voice"房间类型
signaturestring签名,用于验证小游戏的身份
nonceStrstring验证所需的随机字符串
timeStampnumber验证所需的时间戳
groupIdstring小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。
muteConfigMuteConfig静音设置
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

RoomType

房间类型

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

MuteConfig

静音设置

参数类型必填说明
muteMicrophoneboolean是否静音麦克风
muteEarphoneboolean是否静音耳机

FailCallbackResult

参数类型说明
errMsgstring错误信息
errCodekeyof VoipErrCode错误码

SuccessCallbackResult

参数类型说明
openIdListstring[]还在实时语音通话中的成员 openId 名单
errCodenumber错误码
errMsgstring调用结果

VoipErrCode

Voip 错误码

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