登录多房间

功能简介

同一个用户可以同时加入多个房间，并同时在多个房间内推流、拉流、发送实时消息和接收消息回调。

应用场景

本功能可以隔离多个房间的消息及回调，实现更灵活的连麦业务。ZEGO 推荐用于跨房间连麦和在线教育的超级小班场景。

• 跨房间连麦

  主播 A 与主播 B 进行跨房间连麦，主播 A 可以通知房间 A 中所有观众登录主播 B 的房间进行拉流，主播 B 同样可以通知房间 B 中所有观众登录主播 A 的房间进行拉流。

• 超级小班

  老师进入大班房间推流，学生都登录大班房间拉流，同时登录小组房间与同组学生讨论和连麦。助教老师登录小组房间维持课堂秩序或解答学生问题。

示例源码下载

请参考 下载示例源码 获取源码。

相关源码请查看 “/ZegoExpressExample/Examples/Others/MultipleRooms” 目录下的文件。

前提条件

在实现多房间功能之前，请确保：

• 已在项目中集成 ZEGO Express SDK（2.9.0 及以上版本），实现基本的实时音视频功能，详情请参考 快速开始 - 集成 和 快速开始 - 实现流程。

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID 和 AppSign，详情请参考 控制台 - 项目管理 中的“项目信息”。

• 已联系 ZEGO 技术支持开通多房间功能。

使用步骤

以同一用户加入两个房间为例，整体实现流程如下：

1. 在初始化 SDK 之前，将房间模式设置为多房间。
2. 初始化 SDK。
3. 加入第一个房间，成功登录后，可在该房间内推流、拉流、发送和接收实时消息。
4. 加入第二个房间，成功登录后，可在该房间内推流、拉流、发送和接收实时消息。
5. 离开第一个和第二个房间，针对离开房间不做时序上的限制。

具体功能的实现如下：

1 设置多房间模式

必须在初始化 SDK 之前，调用 setRoomMode 接口，通过 ZegoRoomMode 类将房间模式设置为多房间模式，即 “mode” 取值为 “ZegoRoomModeMultiRoom”。

// 设置房间模式为多房间模式
[ZegoExpressEngine setRoomMode:ZegoRoomModeMultiRoom];

// 设置房间模式为多房间模式
[ZegoExpressEngine setRoomMode:ZegoRoomModeMultiRoom];

2 初始化 SDK

请参考 快速开始 - 实现流程 的 “初始化” 进行 SDK 的初始化。

3 登录房间

传入房间 ID（roomID）等参数，调用 loginRoom 接口登录房间。

• 单房间模式下，同一时间只能登录一个房间，调用 loginRoom 接口时，如果之前已经登录其他房间，则会提示已登录相同房间。
• 多房间模式下，同一时间可以登录多个房间，且登录的用户信息必须相同。

[[ZegoExpressEngine sharedEngine] loginRoom:@"multi_room_01" user:[ZegoUser userWithUserID:@"multi_room_user"]];

[[ZegoExpressEngine sharedEngine] loginRoom:@"multi_room_01" user:[ZegoUser userWithUserID:@"multi_room_user"]];

4 推流

传入流 ID（streamID）、房间 ID（roomID）等参数，调用 startPublishingStream（带有 “ZegoPublisherConfig” 参数）接口在指定房间内推流。

ZegoPublisherConfig *config = [[ZegoPublisherConfig alloc] init];
config.roomID = @"multi_room_01";

[[ZegoExpressEngine sharedEngine] startPublishingStream:@"multi_room_publish_01" config:config channel:ZegoPublishChannelMain];

ZegoPublisherConfig *config = [[ZegoPublisherConfig alloc] init];
config.roomID = @"multi_room_01";

[[ZegoExpressEngine sharedEngine] startPublishingStream:@"multi_room_publish_01" config:config channel:ZegoPublishChannelMain];

5 拉流

传入流 ID（streamID）、房间 ID（roomID）等参数，调用 startPlayingStream（带有 “ZegoPlayerConfig” 参数）接口在指定房间内拉流。

ZegoPlayerConfig *config = [[ZegoPlayerConfig alloc] init];
config.roomID = @"multi_room_01";

[[ZegoExpressEngine sharedEngine] startPlayingStream:@"multi_room_player_01" canvas:[ZegoCanvas canvasWithView:self.playView] config:config];

ZegoPlayerConfig *config = [[ZegoPlayerConfig alloc] init];
config.roomID = @"multi_room_01";

[[ZegoExpressEngine sharedEngine] startPlayingStream:@"multi_room_player_01" canvas:[ZegoCanvas canvasWithView:self.playView] config:config];

6 发送/接收实时消息

多房间与单房间发送、接收实时消息的实现一致，详情请参考 常用功能 - 实时消息。

7 退出房间

传入房间 ID（roomID），调用 logoutRoom 接口退出房间。

• 单房间模式下退出房间，同时会停止所有的推拉流。
• 多房间模式下退出房间，可以只退出指定房间，并停止该房间的推拉流。

[[ZegoExpressEngine sharedEngine] logoutRoom:@"multi_room_01"];

[[ZegoExpressEngine sharedEngine] logoutRoom:@"multi_room_01"];

常见问题