实现流程

1 功能简介

本文将介绍如何快速实现一个简单的实时音视频通话。

相关概念解释:

• ZEGO Express SDK：由 ZEGO 提供的实时音视频 SDK，能够为开发者提供便捷接入、高清流畅、多平台互通、低延迟、高并发的音视频服务。
• 推流：把采集阶段封包好的音视频数据流推送到 ZEGO 实时音视频云的过程。
• 拉流：从 ZEGO 实时音视频云将已有音视频数据流拉取播放的过程。
• 房间：是 ZEGO 提供的音视频空间服务，用于组织用户群，同一房间内的用户可以互相收发实时音视频及消息。
  1. 用户需要先登录某个房间，才能进行推流、拉流操作。
  2. 用户只能收到自己所在房间内的相关消息（用户进出、音视频流变化等）。

更多相关概念请参考 术语说明。

2 前提条件

在实现基本的实时音视频功能之前，请确保：

• 已在项目中集成 ZEGO Express SDK，实现基本的实时语音功能，详情请参考 快速开始 - 集成。
• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID，详情请参考 控制台 - 项目管理 中的“项目信息”。

3 使用步骤

以用户 A 拉取用户 B 的流为例，流程如下图：

整个推拉流过程的 API 调用时序如下图：

3.1 创建引擎

1. （可选）创建界面

添加界面元素

在创建引擎之前，推荐开发者添加以下界面元素，方便实现基本的实时音视频功能。

• 本地预览窗口
• 远端视频窗口
• 结束按钮

2. 引入头文件

在项目中引入 ZegoExpressEngine 头文件。

// 引入 ZegoExpressEngine.h 头文件
#import <ZegoExpressEngine/ZegoExpressEngine.h>

3. 创建引擎

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

如果需要注册回调，可将实现了 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];

3.2 登录房间

1. 登录

传入用户 ID 参数 “userID” 创建 ZegoUser 用户对象后，调用 loginRoom 接口，传入房间 ID 参数 “roomID” 和用户参数 “user”，登录房间。

• 同一个 AppID 内，需保证 “roomID” 全局唯一。
• 同一个 AppID 内，需保证 “userID” 全局唯一，建议开发者将其设置成一个有意义的值，可将 “userID” 与自己业务账号系统进行关联。
• ZegoUser 的构造方法 userWithUserID 会将 “userName” 设为与传的参数 “userID” 一样。“userID” 与 “userName” 不能为 “nil”，否则会导致登录房间失败。

// 创建用户对象
ZegoUser *user = [ZegoUser userWithUserID:@"user1"];
// 只有传入 “isUserStatusNotify” 参数取值为 “true” 的 ZegoRoomConfig，才能收到 onRoomUserUpdate 回调。
ZegoRoomConfig *roomConfig = [[ZegoRoomConfig alloc] init];

//如果您使用 appsign 的方式鉴权，token 参数不需填写；如果需要使用更加安全的 鉴权方式： token 鉴权，请参考[如何从 AppSign 鉴权升级为 Token 鉴权](https://doc-zh.zego.im/faq/token_upgrade?product=ExpressVideo&platform=all)
//roomConfig.token = @"xxxxx"; 

roomConfig.isUserStatusNotify = YES;
// 开始登录房间
[[ZegoExpressEngine sharedEngine] loginRoom:@"room1" user:user config:roomConfig callback:^(int errorCode, NSDictionary *extendedData) {
    // (可选回调) 登录房间结果，如果仅关注登录结果，关注此回调即可
}];

2. 监听登录房间后的事件回调

根据实际应用需要，在登录房间后监听想要关注的事件回调，比如房间状态更新、用户状态更新、流状态更新等。

• onRoomStateChanged：房间状态更新回调。登录房间后，当房间连接状态发生变更（如出现房间断开，登录认证失败等情况），SDK 会通过该回调通知。

• onRoomUserUpdate：用户状态更新回调。登录房间后，当房间内有用户新增或删除时，SDK 会通过该回调通知。

  只有调用 loginRoom 接口登录房间时传入 ZegoRoomConfig 配置，且 “isUserStatusNotify” 参数取值为 “true” 时，用户才能收到 onRoomUserUpdate 回调。

• onRoomStreamUpdate：流状态更新回调。登录房间后，当房间内有用户新推送或删除音视频流时，SDK 会通过该回调通知。

// 遵循 ZegoEventHandler 协议处理相关的事件回调
@interface ViewController () <ZegoEventHandler>
// ······
@end

@implementation ViewController

// 常用的房间相关回调

// 房间状态更新回调
-(void)onRoomStateChanged:(ZegoRoomStateChangedReason)reason errorCode:(int)errorCode extendedData:(NSDictionary *)extendedData roomID:(NSString *)roomID {
if(reason == ZegoRoomStateChangedReasonLogining)
    {
        // 登录中
    }
    else if(reason == ZegoRoomStateChangedReasonLogined)
    {
        // 登录成功
        //只有当房间状态是登录成功或重连成功时，推流（startPublishingStream）、拉流（startPlayingStream）才能正常收发音视频
        //将自己的音视频流推送到 ZEGO 音视频云
    }
    else if(reason == ZegoRoomStateChangedReasonLoginFailed)
    {
        // 登录失败
    }
    else if(reason == ZegoRoomStateChangedReasonReconnecting)
    {
        // 重连中
    }
    else if(reason == ZegoRoomStateChangedReasonReconnected)
    {
        // 重连成功
    }
    else if(reason == ZegoRoomStateChangedReasonReconnectFailed)
    {
        // 重连失败
    }
    else if(reason == ZegoRoomStateChangedReasonKickOut)
    {
        // 被踢出房间
    }
    else if(reason == ZegoRoomStateChangedReasonLogout)
    {
        // 登出成功
    }
    else if(reason == ZegoRoomStateChangedReasonLogoutFailed)
    {
        // 登出失败
    }
}

// 用户状态更新回调
// 只有在登录房间（loginRoom）时传的配置 ZegoRoomConfig 中的 isUserStatusNotify 参数为 true 时，用户才能收到此回调。 
- (void)onRoomUserUpdate:(ZegoUpdateType)updateType userList:(NSArray<ZegoUser *> *)userList roomID:(NSString *)roomID {
    // 根据需要实现事件回调
}

// 流状态更新回调
- (void)onRoomStreamUpdate:(ZegoUpdateType)updateType streamList:(NSArray< ZegoStream * > *)streamList extendedData:(nullable NSDictionary *)extendedData roomID:(NSString *)roomID {
    // 根据需要实现事件回调
    //如果用户想要播放其他用户推送的视频，可以在 ZegoUpdateType == ZegoUpdateTypeAdd 时，调用 startPlayingStream， 传入 streamList 中新增的流的 streamID，以拉取远端推送的音视频流。
}

@end

3.3 推流

1. 开始推流

调用 startPublishingStream 接口，传入流 ID 参数 “streamID”，向远端用户发送本端的音视频流。

// 开始推流
[[ZegoExpressEngine sharedEngine] startPublishingStream:@"stream1"];

2. （可选）启用本地预览

// 设置本地预览视图并启动预览，视图模式采用 SDK 默认的模式，等比缩放填充整个 View
[[ZegoExpressEngine sharedEngine] startPreview:[ZegoCanvas canvasWithView:self.view]];

3. 监听推流后的事件回调

根据实际应用需要，在推流后监听想要关注的事件回调，比如推流状态更新等。

onPublisherStateUpdate：推流状态更新回调。调用推流接口成功后，当推流状态发生变更（如出现网络中断导致推流异常等情况），SDK 在重试推流的同时，会通过该回调通知。

// 遵循 ZegoEventHandler 协议处理相关的事件回调
@interface ViewController () <ZegoEventHandler>
// ······
@end

@implementation ViewController

// 常用的推流相关回调

// 推流状态更新回调
- (void)onPublisherStateUpdate:(ZegoPublisherState)state errorCode:(int)errorCode extendedData:(nullable NSDictionary *)extendedData streamID:(NSString *)streamID {
    // 根据需要实现事件回调
}

@end

3.4 拉流

1. 开始拉流

设置 ZegoPlayerConfig 的 “resourceMode” 参数为 “ZegoStreamResourceModeOnlyL3”，调用 startPlayingStream 接口，根据传入的流 ID 参数 “streamID”，拉取远端推送的低延迟直播流。

远端用户推送的 “streamID” 可以从 ZegoEventHandler 代理中的 onRoomStreamUpdate 回调中获得。

// 拉取低延迟流
ZegoPlayerConfig *playerConfig = [[ZegoPlayerConfig alloc] init];
playerConfig.resourceMode = ZegoStreamResourceModeOnlyL3;
[[ZegoExpressEngine sharedEngine] startPlayingStream:@"stream1" canvas:[ZegoCanvas canvasWithView:self.view] config:playerConfig];

2. 监听拉流后的事件回调

根据实际应用需要，在拉流后监听想要关注的事件回调，比如拉流状态更新等。

onPlayerStateUpdate：拉流状态更新回调。调用拉流接口成功后，当拉流状态发生变更（如出现网络中断导致拉流异常等情况），SDK 在重试拉流的同时，会通过该回调通知。

// 遵循 ZegoEventHandler 协议处理相关的事件回调
@interface ViewController () <ZegoEventHandler>
// ······
@end

@implementation ViewController

// 常用的拉流相关回调

// 拉流状态更新回调
- (void)onPlayerStateUpdate:(ZegoPlayerState)state errorCode:(int)errorCode extendedData:(NSDictionary *)extendedData streamID:(NSString *)streamID {
    // 根据需要实现事件回调
}

@end

3.5 停止推拉流

1. 停止推流/预览

调用 stopPublishingStream 接口停止向远端用户发送本端的音视频流。

// 停止推流
[[ZegoExpressEngine sharedEngine] stopPublishingStream];

如果启用了本地预览，调用 stopPreview 接口停止预览。

// 停止本地预览
[[ZegoExpressEngine sharedEngine] stopPreview];

2. 停止拉流

调用 stopPlayingStream 接口停止拉取远端推送的音视频流。

// 停止拉流
[[ZegoExpressEngine sharedEngine] stopPlayingStream:@"stream1"];

3.6 退出房间

调用 logoutRoom 接口退出房间。

// 退出房间
[[ZegoExpressEngine sharedEngine] logoutRoom:@"room1"];

3.7 销毁引擎

调用 destroyEngine 接口销毁引擎，用于释放 SDK 使用的资源。

• 如果需要监听回调，来确保设备硬件资源释放完成，可在销毁引擎时传入 “callback”。该回调只用于发送通知，开发者不可以在回调内释放与引擎相关的资源。

• 如果不需要监听回调，可传入 “nil”。

[ZegoExpressEngine destroyEngine:nil];