微信小程序API 實(shí)時(shí)語音·加入(創(chuàng)建)實(shí)時(shí)語音通話

2022-05-11 16:39 更新

wx.joinVoIPChat(Object object)

基礎(chǔ)庫 2.7.0 開始支持，低版本需做兼容處理。
調(diào)用前需要 用戶授權(quán) scope.record

加入 (創(chuàng)建) 實(shí)時(shí)語音通話，更多信息可見 實(shí)時(shí)語音指南

參數(shù)

Object object

屬性 類型 默認(rèn)值 必填 說明
roomType String voice 否 房間類型
signature String 是 簽名，用于驗(yàn)證小游戲的身份
nonceStr String 是 驗(yàn)證所需的隨機(jī)字符串
timeStamp Number 是 驗(yàn)證所需的時(shí)間戳
groupId String 是 小游戲內(nèi)此房間/群聊的 ID。同一時(shí)刻傳入相同 groupId 的用戶會進(jìn)入到同個(gè)實(shí)時(shí)語音房間。
muteConfig Object 否 靜音設(shè)置
success function 否 接口調(diào)用成功的回調(diào)函數(shù)
fail function 否 接口調(diào)用失敗的回調(diào)函數(shù)
complete function 否 接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會執(zhí)行）

object.roomType 的合法值

值 說明 最低版本
voice 音頻房間，用于語音通話
video 視頻房間，結(jié)合 voip-room 組件可顯示成員畫面

object.muteConfig 的結(jié)構(gòu)

屬性 類型 默認(rèn)值 必填 說明
muteMicrophone Boolean false 否 是否靜音麥克風(fēng)
muteEarphone Boolean false 否 是否靜音耳機(jī)

object.success 回調(diào)函數(shù)

參數(shù)
Object res
屬性 類型 說明
openIdList Array.<String> 在此通話中的成員 openId 名單
errCode Number 錯(cuò)誤碼
errMsg String 調(diào)用結(jié)果

錯(cuò)誤

錯(cuò)誤碼 錯(cuò)誤信息 說明
-1 當(dāng)前已在房間內(nèi)
-2 錄音設(shè)備被占用，可能是當(dāng)前正在使用微信內(nèi)語音通話或系統(tǒng)通話
-3 加入會話期間退出（可能是用戶主動(dòng)退出，或者退后臺、來電等原因），因此加入失敗
-1000 系統(tǒng)錯(cuò)誤


以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號