基本操作

设置加入房间调用监听

调用加入房间接口之前需要先设置方法回调监听，用来判断是否成功加入房间。

方法

JavaScript

rtcEngine.setOnRoomJoinedListener(callback);

回调参数

参数	类型	说明
code	Number	错误码，0 表示成功
message	String	错误信息

示例代码

JavaScript

rtcEngine.setOnRoomJoinedListener((code, message) => {
  if (code === 0) {
    // 创建/加入房间成功
    console.log('加入房间成功');
  } else {
    // 创建/加入房间失败
    console.log('加入房间失败:', message);
  }
});

加入房间

调用 RCRTCEngine 下的 joinRoom 方法加入房间，如果该房间之前不存在，则会在调用时自动创建并加入。

方法

JavaScript

rtcEngine.joinRoom(roomId, setup);

参数说明

参数	类型	必填	说明
roomId	String	是	房间唯一 ID注1
setup	RCRTCRoomSetup	是	加入房间时提供的初始化信息注2

注1：roomId 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式 最长 64 个字符。 注2：setup 内包含用户身份信息和房间的资源类型属性。

示例代码

以会议成员身份加入房间

JavaScript

let setup = {
  type: RCRTCMediaType.AudioVideo,
  role: RCRTCRole.MeetingMember // 会议成员
};
rtcEngine.joinRoom(roomId, setup);
console.log('以会议成员身份加入房间');

以主播身份加入房间

JavaScript

let setup = {
  type: RCRTCMediaType.AudioVideo,
  role: RCRTCRole.LiveBroadcaster // 主播
};
rtcEngine.joinRoom(roomId, setup);
console.log('以主播身份加入房间');

以观众身份加入房间

JavaScript

let setup = {
  type: RCRTCMediaType.AudioVideo,
  role: RCRTCRole.LiveAudience, // 观众
};
rtcEngine.joinRoom(roomId, setup);
console.log('以观众身份加入房间');

设置退出房间调用监听

调用退出房间接口之前建议先设置方法回调监听，用来判断是否成功退出房间。

方法

JavaScript

rtcEngine.setOnRoomLeftListener(callback);

回调参数

参数	类型	说明
code	Number	错误码，0 表示成功
message	String	错误信息

示例代码

JavaScript

rtcEngine.setOnRoomLeftListener((code, message) => {
  if (code === 0) {
    // 退出成功
    console.log('退出房间成功');
  } else {
    // 退出失败
    console.log('退出房间失败:', message);
  }
});

退出房间

调用 RCRTCEngine 下的 leaveRoom 接口离开房间，离开时 SDK 内部会自动取消所有已发布和订阅的资源。

方法

JavaScript

rtcEngine.leaveRoom();

示例代码

JavaScript

rtcEngine.leaveRoom();
console.log('退出房间请求已发送');