多人视频通话

---

功能简介

该文档展示了如何使用 ZEGO Express SDK 构造多人视频通话场景，即实现多对多实时音视频互动。用户可在房间内与其余用户进行实时视频通话，互相推拉流。该场景可用于多人实时视频聊天、视频会议等。

前提条件

在应用多人视频通话场景之前，请确保：

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID 和 AppSign，详情请参考 控制台 - 项目信息。
• 已在项目中集成 ZEGO Express SDK，并实现了基本的音视频推拉流功能，详情请参考 快速开始 - 集成 和 快速开始 - 实现流程。

示例源码下载

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

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

使用步骤

本节将介绍如何使用 ZEGO Express SDK 实现多人视频通话。

• 多人视频通话的流程图如下：

• API 调用时序图如下：

1 创建引擎

调用 createEngine 接口，将申请到的 AppID 和 AppSign 传入参数 “appID” 和 “appSign”，创建引擎单例对象。

如果需要注册回调代理，可将实现了 ZegoEventHandler 的对象（例如 “self”）传入参数 “eventHandler”。如果不需要注册回调代理，可将 “nil” 传入参数 “eventHandler”，创建引擎后仍需要注册回调时可通过调用 setEventHandler 接口设置回调代理。

ZegoEngineProfile *profile = [ZegoEngineProfile new];
// 请通过官网注册获取，格式为：1234567890
profile.appID = appID; 
// 请通过官网注册获取，格式为：@"0123456789012345678901234567890123456789012345678901234567890123"（共64个字符）
profile.appSign = appSign;
//通用场景接入
profile.scenario = ZegoScenarioDefault; 
// 创建引擎，并注册 self 为 eventHandler 回调。不需要注册回调的话，eventHandler 参数可以传 nil，后续可调用 "setEventHandler:" 方法设置回调
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

2 开启房间内用户变化通知

开发者需在每位用户登录房间时将 ZegoRoomConfig 中的 “isUserStatusNotify” 设为 “true” ，用于接收其他用户进出房间的回调通知。

ZegoRoomConfig *roomConfig = [ZegoRoomConfig defaultConfig];
roomConfig.isUserStatusNotify = YES;
[[ZegoExpressEngine sharedEngine] loginRoom:@"room_id_1" user:[ZegoUser userWithUserID:@"user_id_1"] config:roomConfig];

3 设置事件通知回调

为实现多人视频通话功能，需要监听房间内用户和流的增减并做出相应处理，可通过 setEventHandler 设置相关回调。

3.1 监听房间内的用户变化

注册 onRoomUserUpdate 回调，用于监听房间内的用户变化，已登录房间内用户的新增和删除都会触发该回调。

回调中 “updateType” 参数指明了房间内用户变化的类型，该参数取值如下：

用户首次登录房间时，若此房间内已存在其他用户，该新登录用户会通过此回调接收到新增类型的用户列表，也即 “updateType” 为 “ZegoUpdateTypeADD” 的回调，该用户列表为房间内已存在的用户。

// 房间内其他用户增加或减少的通知回调
- (void)onRoomUserUpdate:(ZegoUpdateType)updateType userList:(NSArray<ZegoUser *> *)userList roomID:(NSString *)roomID {
    // 在这里更新 UI 或执行其他操作
}

3.2 监听房间内的流变化

为监听房间内的流变化，需注册 onRoomStreamUpdate 回调，房间内其他用户新增或删除流时将触发此回调通知变更的流列表。

回调中 “updateType” 参数指明了房间内流变化的类型，该参数取值如下：

用户首次登录房间时，若此房间内存在其他用户正在推流，会接收到流新增列表，即 “updateType” 为 “ZegoUpdateTypeADD” 的回调。

- (void)onRoomStreamUpdate:(ZegoUpdateType)updateType streamList:(NSArray<ZegoStream *> *)streamList extendedData:(NSDictionary *)extendedData roomID:(NSString *)roomID {
    // 用户可以在这里实现相应的业务逻辑
}

4 开始推流/拉流

请参考 快速开始 - 实现流程 依次完成“推流”和“拉流”相关操作。

5 停止视频通话

通话过程中，房间内的用户如果需要结束通话，请参考 快速开始 - 实现流程 依次完成相关操作。