Basic Operations

Set Room Join Callback

Before calling the room join API, set up the callback listener to determine whether the room join was successful.

• Sample code:

  engine.onRoomJoined = (int code, String? errMsg) {
    if (code != 0) {
      // Failed to create/join
    } else {
      // Successfully created/joined
    }
  };

Join Room

Call the joinRoom method under RCRTCEngine to join a room. If the room does not exist, it will be automatically created upon joining.

• Parameters:

  Parameter	Type	Description
  roomId	String	Unique room IDNote 1
  setup	RCRTCRoomSetup	Initialization information provided when joining the roomNote 2

  Note 1: roomId supports uppercase/lowercase letters, numbers, and special characters + = - _, with a maximum length of 64 characters. Note 2: setup includes user identity information and room resource type attributes.

• Sample code:

  Join as a meeting member:

  RCRTCRoomSetup setup = RCRTCRoomSetup.create(
    type: RCRTCMediaType.audio_video,
    role: RCRTCRole.meeting_member, // Meeting member
  );
  engine.joinRoom(roomId, setup);

  Join as a live broadcaster:

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

  Join as a live audience:

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

Set Room Exit Callback

Before calling the room exit API, it is recommended to set up the callback listener to determine whether the exit was successful.

• Sample code:

  engine.onRoomLeft = (int code, String? errMsg) {
    if (code != 0) {
      // Failed to exit
    } else {
      // Successfully exited
    }
  };

Leave Room

Call the leaveRoom method under RCRTCEngine to exit the room. The SDK will automatically cancel all published and subscribed resources upon exit.

• Sample code:

  engine.leaveRoom();