Multi-Room Login

Introduction

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, implementing more flexible co-hosting business. ZEGO recommends it for cross-room co-hosting and online education super small class scenarios.

• Cross-room co-hosting

  Host A and Host B conduct cross-room co-hosting. Host A can notify all viewers in room A to log in to Host B's room to play streams, and Host B can also notify all viewers in room B to log in to Host A's room to play streams.

• Super small class

  Teachers enter the large class room to publish streams, students all log in to the large class room to play streams, and simultaneously log in to group rooms to discuss and co-host with students in the same group. Teaching assistants log in to group rooms to maintain classroom order or answer student questions.

Download Sample Source Code

Please refer to Download Sample Source Code to obtain the source code.

For related source code, please check the files in the "/ZegoExpressExample/Examples/Others/MultipleRooms" directory.

Prerequisites

Before implementing multi-room functionality, ensure that:

• ZEGO Express SDK (version 2.9.0 and above) has been integrated into the project, and basic real-time audio and video functionality has been implemented. For details, please refer to Quick Start - Integration and Quick Start - Implementation Process.

• A project has been created in the ZEGOCLOUD Console, and valid AppID and AppSign have been obtained.

• ZEGOCLOUD Technical Support has been contacted to enable the multi-room feature.

Usage Steps

Taking the same user joining two rooms as an example, the overall implementation process 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 this room.
4. Join the second room. After successful login, you can publish streams, play streams, send and receive real-time messages in this 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

Must call the setRoomMode interface before initializing the SDK, and set the room mode to multi-room mode through the ZegoRoomMode class, that is, the "mode" value is "ZEGO_ROOM_MODE_MULTI_ROOM".

// Set room mode to multi-room mode
ZegoExpressSDK::setRoomMode(ZegoRoomMode::ZEGO_ROOM_MODE_MULTI_ROOM)

// Set room mode to multi-room mode
ZegoExpressSDK::setRoomMode(ZegoRoomMode::ZEGO_ROOM_MODE_MULTI_ROOM)

2 Initialize SDK

Please refer to "Create Engine" in Quick Start - Implementation Process for SDK initialization.

3 Login 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 other rooms, you will be prompted that you have 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("userID", "userName");

// Start logging in to room
engine->loginRoom("roomID", user);

// Create user
ZegoUser user("userID", "userName");

// Start logging in to room
engine->loginRoom("roomID", 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;
config.roomID = "room1";

// Start publishing stream
engine->startPublishingStream("streamID", config);

ZegoPublisherConfig config;
config.roomID = "room1";

// Start publishing stream
engine->startPublishingStream("streamID", config);

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;
config.roomID = "room1";

// Play real-time stream
// Fill in Windows window handle
HWND playWND = ...;
ZegoCanvas canvas(playWND);
engine->startPlayingStream("streamID", &canvas, config);

ZegoPlayerConfig config;
config.roomID = "room1";

// Play real-time stream
// Fill in Windows window handle
HWND playWND = ...;
ZegoCanvas canvas(playWND);
engine->startPlayingStream("streamID", &canvas, 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 Real-time Messages and Signaling.

7 Leave Room

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

• Leaving a room in single-room mode will stop all publishing and playing streams at the same time.
• Leaving a room in multi-room mode can only leave the specified room and stop publishing and playing streams for that room.

// Leave room
engine->logoutRoom("roomID");

// Leave room
engine->logoutRoom("roomID");

FAQ