快速实现超低延迟直播

本文将介绍如何通过超低延迟直播功能，快速实现一个简单的视频直播。

1 简介

相关概念解释:

• ZEGO Express SDK：由 ZEGO 提供的实时音视频和直播 SDK，能够为开发者提供便捷接入、高清流畅、多平台互通、低延迟、高并发的音视频服务。
• 流：指一组按指定编码格式封装，不断发送中的音视频数据。一个用户可以同时推多条流（例如一条推摄像头数据，一条推屏幕共享数据）也可以同时拉多条流。每条流都由一个流 ID（streamID）标识。
• 推流：把采集阶段封包好的音视频数据流推送到 ZEGO 实时音视频云的过程。
• 拉流：从 ZEGO MSDN 网络将已有音视频数据流拉取播放的过程。
• 房间：是 ZEGO 提供的音视频空间服务，用于组织用户群，同一房间内的用户可以互相收发实时音视频及消息。
  • 用户需要先登录某个房间，才能进行推流、拉流操作。
  • 用户只能收到自己所在房间内的相关消息（用户进出、音视频流变化等）。
  • 每个房间由一个 ApplD 内唯一的 roomlD 标识。所有使用同一个 roomID 登录房间的用户即属于同房间。

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

2 前提条件

在实现基本的超低延迟直播直播功能之前，请确保：

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

3 实现流程

用户通过 ZEGO Express SDK 进行视频直播的基本流程为：

用户 A、B 加入房间，用户 B 预览并将音视频流推送到 ZEGO 云服务（推流），用户 A 收到用户 B 推送音视频流的通知之后，在通知中播放用户 B 的音视频流（拉流）。

3.1 开通服务

超低延迟直播功能不是默认开启的，使用前请在 ZEGO 控制台 自助开通（开通步骤请参考 项目管理 - 服务配置 中的“超低延迟直播”），或联系 ZEGO 技术支持开通。

3.2 初始化

1. 创建界面

添加界面元素

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

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

• 当本地用户为主播时，才会显示本地视频窗口，即若本地用户为观众，仅显示远端视频窗口。
• 当远端用户为主播时，才会显示远端视频窗口。

2. 引入 SDK

在项目中引入 SDK。

import 'package:zego_express_engine/zego_express_engine.dart';

3. 创建引擎

调用 createEngineWithProfile 接口，将申请到的 AppID 和 AppSign 传入参数 “appID” 和 “appSign”。 Web 平台无需使用 “appsign”，为以免暴露，Web 平台请勿传入 “appsign”。

ZegoEngineProfile profile = ZegoEngineProfile(
    appID, // 请通过官网注册获取，格式为：1234567890
    ZegoScenario.General, // 通用场景接入
    appSign: appSign，// 请通过官网注册获取，格式为：'0123456789012345678901234567890123456789012345678901234567890123'（共64个字符），Web 平台无需传入
    enablePlatformView: true); //Web 平台需为true
// 创建引擎
ZegoExpressEngine.createEngineWithProfile(profile);

4. 设置回调

创建引擎后，开发者可以根据需要选择使用匿名函数实现回调函数，并将其赋值给引擎实例对应的回调函数属性以注册回调

ZegoExpressEngine.onRoomStateChanged = (String roomID, ZegoRoomStateChangedReason reason, int errorCode, Map<String, dynamic> extendedData) {
        if(reason == ZegoRoomStateChangedReason.Logining)
        {
            // 登录中
            // 代表开发者主动调用 loginRoom 触发的连接中的回调
        }
        else if(reason == ZegoRoomStateChangedReason.Logined)
        {
            // 登录成功
            // 当前是开发者主动调用 loginRoom 登录成功触发的回调，这里可以处理首次登录房间成功的业务逻辑，比如拉取聊天室、直播间基础信息。
        }
        else if(reason == ZegoRoomStateChangedReason.LoginFailed)
        {
            // 登录失败
            if (errorCode == 1002033) {
                //当使用登录房间鉴权的功能时，传入的 token 出错导
            }
        }
        else if(reason == ZegoRoomStateChangedReason.Reconnecting)
        {
             // 重连中
             // 当前是 SDK 断线重连成功触发的回调，这里建议展示一些重连的 UI
        }
        else if(reason == ZegoRoomStateChangedReason.Reconnected)
        {
             // 重连成功
        }
        else if(reason == ZegoRoomStateChangedReason.ReconnectFailed)
        {
             // 重连失败
             // 当房间连接彻底断开时，SDK 不会再进行重连，开发者如果需要再次登录房间，可以主动调用 loginRoom 接口
             // 此时可以在业务中退出房间/直播间/课堂，或者手动调用接口再次登录
        }
        else if(reason == ZegoRoomStateChangedReason.KickOut)
        {
             // 被踢出房间
             if (errorCode == 1002050) {
                 // 用户被踢出房间（由于 userID 相同的用户在其他地方登录）
             }
             else if (errorCode == 1002055) {
                 // 用户被踢出房间（开发者主动调用后台的踢人接口）
             }
         }
         else if(reason == ZegoRoomStateChangedReason.Logout)
         {
              // 登出成功
              // 开发者主动调用 logoutRoom 登出房间
              // 开发者可以在这里处理主动登出房间回调的逻辑
         }
         else if(reason == ZegoRoomStateChangedReason.LogoutFailed)
         {
              // 登出失败
              // 登出房间 ID 错误
         }
    };

ZegoExpressEngine.onRoomUserUpdate = (String roomID, ZegoUpdateType updateType, List<ZegoUser> userList) {
     //房间用户变化回调，实际业务流程需开发者按需设计
     if(updateType == ZegoUpdateType.Add){
         // 当 “updateType” 为 “Add” 时，用户可以拉取 userList 里的用户进行处理
         for(ZegoUser user : userList){
             // user 加入房间
         }
     }else{
         // 当 “updateType” 为 “Delete” 时，用户可以拉取 userList 里的用户进行处理
         for(ZegoUser user : userList){
             // user 离开房间
         }
     }
};

// 常用的推流相关回调
// 推流状态更新回调
ZegoExpressEngine.onPublisherStateUpdate = (String streamID, ZegoPublisherState state, int errorCode, Map<String, dynamic> extendedData) {
    // 根据需要实现事件回调
};

// 常用的拉流相关回调
// 拉流状态相关回调
ZegoExpressEngine.onPlayerStateUpdate = (String streamID, ZegoPlayerState state, int errorCode, Map<String, dynamic> extendedData) {
    // 根据需要实现事件回调
};

3.3 登录房间

• 生成 Token

开发者可在 ZEGO 控制台获取临时 Token（有效期为 24 小时），详情请参考 控制台 - 开发辅助。

传入用户 ID 参数 “userID” 创建 ZegoUser 用户对象后，调用 loginRoom 接口，传入房间 ID 参数 “roomID” 和用户参数 “user”，登录房间。如果房间不存在，调用该接口时会创建并登录此房间。

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

// 创建用户对象
ZegoUser user = ZegoUser.id('user1');
// 只有传入 “isUserStatusNotify” 参数取值为 “true” 的 ZegoRoomConfig，才能收到 onRoomUserUpdate 回调。
ZegoRoomConfig config = ZegoRoomConfig.defaultConfig();
config.isUserStatusNotify = true;
// 如果您使用 appsign 的方式鉴权，token 参数不需填写；如果需要使用更加安全的 鉴权方式： token 鉴权，Web 平台仅支持 token 鉴权，请参考[如何从 AppSign 鉴权升级为 Token 鉴权](https://doc-zh.zego.im/faq/token_upgrade?product=ExpressVideo&platform=all)
// config.token = "xxxx";
// 开始登录房间
ZegoExpressEngine.instance.loginRoom('room1', user, config: config);

登录状态（房间连接状态）回调

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

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

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

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

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

// 以下为常用的房间相关回调
// 房间状态更新回调
ZegoExpressEngine.onRoomStateUpdate = (String roomID, ZegoRoomState state, int errorCode, Map<String, dynamic> extendedData) {
    // 根据需要实现事件回调
};

// 用户状态更新
ZegoExpressEngine.onRoomUserUpdate = (String roomID, ZegoUpdateType updateType, List<ZegoUser> userList) {
    // 根据需要实现事件回调
};

// 流状态更新
ZegoExpressEngine.onRoomStreamUpdate = (String roomID, ZegoUpdateType updateType, List<ZegoStream> streamList) {
    // 根据需要实现事件回调
};

3.4 主播预览自己的画面，并推送到 ZEGO 音视频云

1. （可选）主播预览自己的画面

// 将此 Widget 加入到页面的渲染树中以显示预览画面
_previewViewWidget = await ZegoExpressEngine.instance.createCanvasView((viewID) {
    _previewViewID = viewID;

    // Set the preview canvas
    ZegoCanvas previewCanvas = ZegoCanvas.view(viewID);

    // Start preview
    ZegoExpressEngine.instance.startPreview(canvas: previewCanvas);
});

2. 主播将自己的音视频流推送到 ZEGO 音视频云

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

// 开始推流
ZegoExpressEngine.instance.startPublishingStream("streamID");

3.5 拉取主播的音视频

进行直播时，我们需要拉取到主播的音视频。使用超低延迟直播拉流的延迟，可以控制在 1s 以内，更能实现超低延迟、超强同步、抗极端弱网、超低卡顿、超清画质、首帧秒开的极致直播体验。

在同一房间内的其他用户将音视频流推送到 ZEGO 音视频云时，会在 onRoomStreamUpdate 回调中收到音视频流新增的通知，并可以获取到某条流的 “streamID”。

开发者可以在该回调中，调用 startPlayingStream 接口。您可通过监听 onPlayerStateUpdate 回调知晓是否成功拉取音视频。

调用 startPlayingStream 接口，并将 “resourceMode” 参数设置为 “ZegoStreamResourceMode.ONLY_L3”，表示超低延迟直播拉流。

// 将此 Widget 加入到页面的渲染树中以显示预览画面
_playViewWidget = await ZegoExpressEngine.instance.createCanvasView((viewID) {
    _playViewID = viewID;

    // Set the playing canvas
    ZegoCanvas canvas = ZegoCanvas.view(viewID);

    // Start playing
    ZegoExpressEngine.instance.startPlayingStream(streamID, 
        canvas: canvas, 
        config: ZegoPlayerConfig(ZegoStreamResourceMode.ONLY_L3,videoCodecID: ZegoVideoCodecID.Default, roomID: roomID));
});

3.6 调试超低延迟直播功能

在真机中运行项目，运行成功后，可以看到本端视频画面。

为方便体验，ZEGO 提供了一个 Web 端调试示例 ，在该页面下，输入相同的 AppID、RoomID、Server 地址和 Token，即可加入同一房间与真机设备互通。当成功开直播时，可以听到远端的音频，看到远端的视频画面。

3.7 停止推送/拉取音视频流

1. 停止推流，停止预览

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

// 停止推流
ZegoExpressEngine.instance.stopPublishingStream();

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

// 停止预览
ZegoExpressEngine.instance.stopPreview();

如果预览时使用了 createCanvasView，需要调用 destroyCanvasView 接口销毁。

// _previewViewID 为调用 [createCanvasView] 时得到的 viewID
ZegoExpressEngine.instance.destroyCanvasView(_previewViewID);

2. 停止拉流

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

// 停止拉流
ZegoExpressEngine.instance.stopPlayingStream(streamID);

如果拉流时使用了 createCanvasView，需要调用 destroyCanvasView 接口销毁。

// _playViewID 为调用 [createCanvasView] 时得到的 viewID
ZegoExpressEngine.instance.destroyCanvasView(_playViewID);

3.8 退出房间

调用 logoutRoom 接口退出房间。

// 退出房间
ZegoExpressEngine.instance.logoutRoom('room1');

3.9 销毁引擎

如果用户彻底不使用音视频功能时，可调用 destroyEngine 接口销毁引擎，用于释放 SDK 使用的资源。

// 销毁引擎
ZegoExpressEngine.destroyEngine();