基本操作

设置加入房间事件回调监听

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

方法

Dart

RCRTCEngine.onRoomJoined

返回值

参数	描述
code	接口结果码
errMsg	失败原因

示例代码

Dart

engine.onRoomJoined = (int code, String? errMsg) {
  if (code != 0) {
    // 创建/加入失败
  } else {
    // 创建/加入成功
  }
};

加入房间

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

方法

Dart

RCRTCEngine.joinRoom();

参数说明

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

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

示例代码

以会议成员身份加入房间

Dart

RCRTCRoomSetup setup = RCRTCRoomSetup.create(
  type: RCRTCMediaType.audio_video,
  role: RCRTCRole.meeting_member, // 会议成员
);
engine.joinRoom(roomId, setup);

以主播身份加入房间

Dart

RCRTCRoomSetup setup = RCRTCRoomSetup.create(
  type: RCRTCMediaType.audio_video,
  role: RCRTCRole.live_broadcaster, // 主播
);
engine.joinRoom(roomId, setup);

以观众身份加入房间

Dart

RCRTCRoomSetup setup = RCRTCRoomSetup.create(
  type: RCRTCMediaType.audio_video,
  role: RCRTCRole.live_audience, // 观众
);
engine.joinRoom(roomId, setup);

设置退出房间事件回调监听

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

方法

Dart

RCRTCEngine.onRoomLeft

返回值

参数	描述
code	接口结果码
errMsg	失败原因

示例代码

Dart

engine.onRoomLeft = (int code, String? errMsg) {
  if (code != 0) {
    // 退出失败
  } else {
    // 退出成功
  }
};

退出房间

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

方法

Dart

RCRTCEngine.leaveRoom();

参数说明

无参数

示例代码

Dart

engine.leaveRoom();