基础库 2.42.0 开始支持本方法,这是一个异步方法。

加入实时音视频通话房间

前提条件
业务背景
使用限制
注意事项
  • Tip: 同一用户同一时间只能加入一个房间。接口调用成功后,若未成功退出房间,再次调用进房接口时,无论 userId 或 roomId 是否重复,皆回调失败。
  • Tip: token需要对接火山引擎获取(https://www.volcengine.com/docs/6348/70121
支持沙盒
相关教程

语法

RtcRoomContext.joinRtcRoom(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
roomConfigobject
房间配置(控制是否自动发布和是否自动订阅)
2.42.0
roomIdstring
加入的房间 id
2.42.0
tokenstring
临时动态密钥
2.42.0
userIdstring
用户 id(业务侧自行定义,唯一区分用户)
2.42.0
successfunction
接口调用成功的回调函数
2.42.0
failfunction
接口调用失败的回调函数
2.42.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
2.42.0

roomConfig 类型说明

object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
autoPublishbooleantrue
是否自动发布音视频流
2.68.0
autoSubscribebooleantrue
是否自动订阅音视频流
2.68.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"joinRtcRoom:ok"
2.42.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"joinRtcRoom:fail" + 详细错误信息
2.42.0

errMsg 参数说明

错误码

错误信息

错误说明

最低支持版本

10200

"joinRtcRoom:fail auth deny

用户拒绝授权

2.42.0

20000

"joinRtcRoom:fail"  + 详细错误信息

参数错误

2.42.0

21100

"joinRtcRoom:fail user %s is already in the room %s"

用户已在房间内

2.42.0

21101

"joinRtcRoom:fail invalid token"

token 无效

2.42.0

21102

"joinRtcRoom:fail %s"

加入房间时发生未知错误

2.42.0

错误码

errorCodeerrMsgerrorType说明最低支持版本
115910joinRtcRoom:fail engine has been destroyed,please invoke tt.createRtcRoomContext create new engineD
rtc实例已销毁

重新调用tt.createRtcRoomContext

2.42.0
115999params invalidD
参数非法

请检查token,roomId,userId参数是否传值

2.42.0
115903joinRtcRoom:fail error code:xxxF
小程序框架内部错误,有需要请创建工单咨询
2.42.0
115901joinRtcRoom:fail user xxx is already in the room xxxD
用户已经在房间中,请不要重复加入房间

用户已在房间中,请先退出当前房间再进房

2.42.0
115902joinRtcRoom:fail invalid tokenD
token非法或者已过期

检查token有效性

2.42.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

<view class="title">rtc 组件</view> <view class="rtc-container"> <view>{{ error }}</view> <rtc-room tt:for="{{userIdList}}" tt:key="item.userId" id="{{ item.userId }}" class="rtc-item {{ item.class }}" userId="{{ item.userId }}" device-position="front" bindtap="scaleCamera" binderror="handleError" mode="{{ item.mode }}"> </rtc-room> </view> <view class="title">房间信息</view> <view class="rtc-api-name">appId</view> <view class="room-message">{{ appId }}</view> <view class="rtc-api-name">token</view> <view class="room-message token">{{ token }}</view> <view class="rtc-api-name">roomId</view> <view class="room-message">{{ roomId }}</view> <view class="rtc-api-name">useId</view> <view class="room-message">{{ userId }}</view> <view class="title">rtc Api</view> <view class="rtc-api-name">api名称: joinRtcRoom</view> <button class="rtc-api" type="default" size="default" bindtap="joinRtcRoom">加入房间</button>
import { RTC_APP_ID } from "../../utils/constant"; Page({ data: { ctx: null, userIdList: [], videoState: 0, audioState: 0, streamPublishState: 0, streamSubscribeState: 0, screenSubscribeState: 0, visible: false, device: "speakerphone", appId: RTC_APP_ID, // 每个应用的唯一标识符,由 RTC 控制台随机生成的。不同的 AppId 生成的实例在 RTC 中进行音视频通话完全独立,无法互通。 token: "", roomId: "", userId: "", camera: "front", scaleUserId: "", error: "no error", }, onLoad(options) { const { userId, roomId, token } = options; this.setData({ userId, roomId, token: decodeURIComponent(token), }); this.data.ctx = tt.createRtcRoomContext({ appId: this.data.appId, }); }, joinRtcRoom() { this.data.ctx.joinRtcRoom({ roomId: this.data.roomId, token: this.data.token, userId: this.data.userId, success: (res) => { console.log("joinRtcRoom success ", res); }, fail(res) { console.log("joinRtcRoom fail ", res); }, complete(res) { console.log("joinRtcRoom complete ", res); }, }); }, });