快速实现超低延迟直播

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

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. 创建界面（可选）

添加界面元素

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

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

2. 创建引擎

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

// 导入
import ZegoExpressEngine from 'zego-express-engine-reactnative';

// 采用通用场景
const profile = {
appID : xxx,
// AppSign 仅满足简单的鉴权需求，如果需要升级为更加安全的鉴权方式，请参考[如何从 AppSign 鉴权升级为 Token 鉴权](https://doc-zh.zego.im/faq/token_upgrade?product=ExpressVideo&platform=all)
// AppSign 可通过[控制台](https://console.zego.im/dashboard)获取，格式为 @"39011cbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
appSign: '39011cbxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
scenario : 0
};

ZegoExpressEngine.createEngineWithProfile(profile)

3.设置回调

创建引擎后，您可以通过引擎实例的on方法注册回调。

ZegoExpressEngine.instance().on('roomStateChanged', (roomID, reason, errorCode, extendedData) => {

});

ZegoExpressEngine.instance().on('roomUserUpdate', (roomID, updateType, userList) => {
    // 您可以在回调中根据用户的进出/退出情况，处理对应的业务逻辑
    if (updateType == ZegoUpdateType.Add) {
        for (user in userList) {
            //("用户 %s 进入了房间 %s", user.userName, roomID);
        }
    } else if (updateType == ZegoUpdateType.Delete) {
        for (user in userList) {
            //("用户 %s 退出了房间 %s", user.userName, roomID);
        }
    }
});

ZegoExpressEngine.instance().on('publisherStateUpdate', (streamID, state, errorCode, extendedData) => {
    if (errorCode != 0) {
        //("推流状态出错 errorCode: %d", errorCode);
    } else {
        switch (state) {
            case ZegoPublisherState.Publishing:
                //("正在推流");
                break;
            case ZegoPublisherState.PublishRequesting:
                //("正在请求推流");
                break;
            case ZegoPublisherState.NoPublish:
                //("没有推流");
                break;
        }
    }
});

ZegoExpressEngine.instance().on('playerStateUpdate', (streamID, state, errorCode, extendedData) => {
    if (errorCode != 0) {
        //("拉流状态出错 errorCode: %d", errorCode);
    } else {
        switch (state) {
            case ZegoPlayerState.Playing:
                //("正在拉流中");
                break;
            case ZegoPlayerState.PlayRequesting:
                //("正在请求拉流中");
                break;
            case ZegoPlayerState.NoPlay:
                //("未进行拉流");
                break;
        }
    }
});

3.3 登录房间

• 生成 Token

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

1. 登录

您可以调用 loginRoom 接口登录房间。如果房间不存在，调用该接口时会创建并登录此房间。

roomID 和 user 的参数由您本地生成，但是需要满足以下条件：

• 同一个 AppID 内，需保证 “roomID” 全局唯一。
• 同一个 AppID 内，需保证 “userID” 全局唯一，建议开发者将 “userID” 与自己业务的账号系统进行关联。

let roomConfig = new ZegoRoomConfig();
// 如果您使用 appsign 的方式鉴权，token 参数不需填写；如果需要使用更加安全的 鉴权方式： token 鉴权，请参考[如何从 AppSign 鉴权升级为 Token 鉴权](https://doc-zh.zego.im/faq/token_upgrade?product=ExpressVideo&platform=all)
// roomConfig.token = "xxxx";
// 只有传入 “isUserStatusNotify” 参数取值为 “true” 的 ZegoRoomConfig，才能收到 onRoomUserUpdate 回调。
roomConfig.isUserStatusNotify = true;
// 登录房间
// 开始登录房间
ZegoExpressEngine.instance().loginRoom('room1', {'userID': 'id1', 'userName': 'user1'}, roomConfig);

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

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

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

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

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

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

// 以下为常用的房间相关回调

ZegoExpressEngine.instance().on('roomStateUpdate', (roomID, state, errorCode, extendedData) => {
  // 房间状态更新回调，登录房间后，当房间连接状态发生变更（如出现房间断开，登录认证失败等情况），SDK会通过该回调通知
});


ZegoExpressEngine.instance().on('roomUserUpdate', (roomID, updateType, userList) => {
  // 用户状态更新，登录房间后，当房间内有用户新增或删除时，SDK会通过该回调通知
});

ZegoExpressEngine.instance().on('roomStreamUpdate', (roomID, updateType, streamList) => {
  // 流状态更新，登录房间后，当房间内有用户新推送或删除音视频流时，SDK会通过该回调通知
});

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

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

如果希望看到本端的画面，可调用 startPreview 接口设置预览视图，并启动本地预览。

import { findNodeHandle } from 'react-native';

// 取一个react 的 ref
let localViewRef = findNodeHandle(this.refs.zego_preview_view);

// 启动本地预览
ZegoExpressEngine.instance().startPreview({
    'reactTag': localViewRef,
    'viewMode': 0,
    'backgroundColor': 0
});

// react render
render() {
    return (
        <View>
            <ZegoTextureView ref='zego_preview_view'/>
        </view>
    )
}

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

在用户调用 loginRoom 接口后，可以直接调用 startPublishingStream 接口，传入 “streamID”，将自己的音视频流推送到 ZEGO 音视频云。您可通过监听 publisherStateUpdate 回调知晓推流是否成功。

“streamID” 由您本地生成，但是需要保证：

同一个 AppID 下，“streamID” 全局唯一。如果同一个 AppID 下，不同用户各推了一条 “streamID” 相同的流，后推流的用户推流失败。

此处示例在调用 loginRoom 接口后立即进行推流。在实现具体业务时，您可选择其他时机进行推流，只要保证先调用 loginRoom 即可。

// 用户调用 loginRoom 之后再调用此接口进行推流
// 在同一个 AppID 下，开发者需要保证“streamID” 全局唯一，如果不同用户各推了一条 “streamID” 相同的流，后推流的用户会推流失败。 
ZegoExpressEngine.instance().startPublishingStream("streamID");

3.5 拉取主播的音视频

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

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

我们可以在该回调中，调用 startPlayingStream 接口，传入 “streamID” 拉取播放该用户的音视频。您可通过监听 playerStateUpdate 回调知晓是否成功拉取音视频。您可以使用如下拉流方式。

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

import { findNodeHandle } from 'react-native';

// 取一个react 的 ref
let playViewRef = findNodeHandle(this.refs.zego_play_view);

// react render
render() {
    return (
        <View>
            <ZegoTextureView ref='zego_play_view'/>
        </view>
    )
}

// 房间内其他用户推流/停止推流时，我们会在这里收到相应流增减的通知
ZegoExpressEngine.instance().on('roomStreamUpdate', (roomID, updateType, streamList) => {
    if (updateType == ZegoUpdateType.Add) {
        // 这里为了使示例代码更加简洁，我们只拉取新增的音视频流列表中第的第一条流，在实际的业务中，建议开发者循环遍历 streamList ，拉取每一条音视频流 
        var stream = streamList[0];
        var canvas = {
            'reactTag': playViewRef,
            'viewMode': 0,
            'backgroundColor': 0
        }
        var config = {'resourceMode': ZegoStreamResourceMode.OnlyL3};
        // 开始拉流
        ZegoExpressEngine.instance().startPlayingStream(stream.streamID, canvas, config);
    }
});

3.6 调试超低延迟直播功能

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

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

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

1. 停止推流，停止预览

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

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

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

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

2. 停止拉流

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

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

3.8 退出房间

调用 logoutRoom 接口退出房间，本端会收到 roomStateUpdate 回调通知调用结果，并停止其所有推拉流以及本地预览。

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

3.9 销毁引擎

如果用户彻底不使用音视频功能时，可调用 destroyEngine 接口销毁引擎，释放麦克风、摄像头、内存、CPU 等资源。

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

  ZegoExpressEngine.destroyEngine();

4 直播 API 调用时序

5 常见问题

1. 调用 logoutRoom 登出房间时能否直接杀掉进程？

调用 logoutRoom 后直接杀掉进程，有一定概率会导致 logoutRoom 信令没发出去，那么 ZEGO 服务端只能等心跳超时后才认为这个用户退出了房间，为了确保 logoutRoom 信令发送出去，建议再调用 destroyEngine 并收到回调后再杀进程。

相关文档

• 常见错误码

• 如何处理房间与用户的相关问题？

• 如何设置和获取 SDK 的日志、堆栈信息？

• SDK 是否支持断线重连？

• 直播场景下，如何监听远端观众角色用户登录/退出房间的事件？

• 如何调节摄像头的焦距（变焦功能）？

• 为什么我无法打开摄像头？

• 如何在较差的网络环境中保证音视频流畅（流量控制功能）？