Login to Multiple Rooms

Feature Overview

The same user can join multiple rooms at the same time, and simultaneously publish streams, play streams, send real-time messages, and receive message callbacks in multiple rooms.

Application Scenarios

This feature can isolate messages and callbacks of multiple rooms, achieving more flexible co-hosting business. ZEGO recommends using it for cross-room co-hosting and super small class scenarios in online education.

• Cross-room Co-hosting

  Streamer A and Streamer B perform cross-room co-hosting. Streamer A can notify all viewers in Room A to log in to Streamer B's room to play streams. Streamer B can similarly notify all viewers in Room B to log in to Streamer A's room to play streams.

• Super Small Class

  The teacher enters the large class room to publish streams, and all students log in to the large class room to play streams. At the same time, they log in to the group room to discuss and co-host with students in the same group. The teaching assistant logs in to the group room to maintain classroom order or answer student questions.

Example Source Code Download

Please refer to Download Example Source Code to get the source code.

For related source code, please check the files in the "/ZegoExpressExample/Others/src/main/java/im/zego/others/multiplerooms" directory.

Prerequisites

Before implementing multi-room functionality, please ensure:

• You have integrated ZEGO Express SDK (version 2.9.0 and above) in your project and implemented basic real-time audio and video functionality. For details, please refer to Quick Start - Integration and Quick Start - Implementation.

• You have created a project in the ZEGOCLOUD Console and applied for a valid AppID and AppSign.

• You have contacted ZEGO Technical Support to enable the multi-room feature.

Usage Steps

Taking the same user joining two rooms as an example, the overall implementation flow is as follows:

1. Before initializing the SDK, set the room mode to multi-room.
2. Initialize the SDK.
3. Join the first room. After successful login, you can publish streams, play streams, send and receive real-time messages in that room.
4. Join the second room. After successful login, you can publish streams, play streams, send and receive real-time messages in that room.
5. Leave the first and second rooms. There is no timing restriction on leaving rooms.

The implementation of specific functions is as follows:

1 Set Multi-Room Mode

Before initializing the SDK, you must call the setRoomMode interface and use the ZegoRoomMode class to set the room mode to multi-room mode, that is, the "mode" value is "MULTI_ROOM".

// Set room mode to multi-room mode
ZegoExpressEngine.setRoomMode(ZegoRoomMode.MULTI_ROOM)

// Set room mode to multi-room mode
ZegoExpressEngine.setRoomMode(ZegoRoomMode.MULTI_ROOM)

2 Initialize SDK

Please refer to "Initialization" in Quick Start - Implementation to initialize the SDK.

3 Login to Room

Pass in parameters such as room ID (roomID) and call the loginRoom interface to log in to the room.

• In single-room mode, you can only log in to one room at the same time. When calling the loginRoom interface, if you have already logged in to another room, you will be prompted that you are already logged in to the same room.
• In multi-room mode, you can log in to multiple rooms at the same time, and the logged-in user information must be the same.

// Create user
ZegoUser user = new ZegoUser("user1");

// Start logging in to room
engine.loginRoom("room1", user);

// Create user
ZegoUser user = new ZegoUser("user1");

// Start logging in to room
engine.loginRoom("room1", user);

4 Publish Stream

Pass in parameters such as stream ID (streamID) and room ID (roomID), and call the startPublishingStream (with "ZegoPublisherConfig" parameter) interface to publish stream in the specified room.

ZegoPublisherConfig config = new ZegoPublisherConfig();
config.roomID = "room1";

// Start publishing stream
engine.startPublishingStream("stream1", config, ZegoPublishChannel.MAIN);

ZegoPublisherConfig config = new ZegoPublisherConfig();
config.roomID = "room1";

// Start publishing stream
engine.startPublishingStream("stream1", config, ZegoPublishChannel.MAIN);

5 Play Stream

Pass in parameters such as stream ID (streamID) and room ID (roomID), and call the startPlayingStream (with "ZegoPlayerConfig" parameter) interface to play stream in the specified room.

ZegoPlayerConfig config = new ZegoPlayerConfig();
config.roomID = "room1";

// The following play_view is a SurfaceView/TextureView/SurfaceTexture object on the UI interface
engine.startPlayingStream("stream1", new ZegoCanvas(play_view), config);

ZegoPlayerConfig config = new ZegoPlayerConfig();
config.roomID = "room1";

// The following play_view is a SurfaceView/TextureView/SurfaceTexture object on the UI interface
engine.startPlayingStream("stream1", new ZegoCanvas(play_view), config);

6 Send/Receive Real-Time Messages

The implementation of sending and receiving real-time messages in multi-room and single-room is the same. For details, please refer to Common Features - Real-Time Messages.

7 Logout Room

Pass in the room ID (roomID) and call the logoutRoom interface to leave the room.

• In single-room mode, exiting the room will stop all stream publishing and playing at the same time.
• In multi-room mode, exiting the room can only exit the specified room and stop stream publishing and playing for that room.

// Logout room
engine.logoutRoom("room1");

// Logout room
engine.logoutRoom("room1");

FAQ