实时音视频
  • 平台类型
  • 框架 / 引擎
  • iOS
  • Android
  • macOS
  • Windows
  • Linux
  • Web
  • 小程序

实现流程

更新时间:2021-09-08 15:08

1 功能简介

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

相关概念解释:

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

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

2 前提条件

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

3 使用步骤

以用户 A 拉取用户 B 的流为例,流程如下图:

/Pics/Common/ZegoExpressEngine/common_usage.png

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

时序图

3.1 创建引擎

1. (可选)创建界面

添加界面元素

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

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

2. 创建引擎

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

如果需要注册回调,可将实现了 IZegoEventHandler 的对象传入参数 “eventHandler”。如果不需要注册回调,可将 “null” 传入参数 “eventHandler”,创建引擎后仍需要注册回调时可通过调用 setEventHandler 接口设置回调。

  • 针对 2021-09-30 及之前注册 ZEGO 控制台 的用户:

    • 从控制台申请的 AppID 和 AppSign 等信息默认是测试环境,需要在初始化 SDK 前设置测试环境,否则 SDK 会初始化失败。应用正式上线前,请向 ZEGO 商务人员申请开启正式环境。
    • createEngine 接口中的 “isTestEnv” 参数设置为 “true” 时表示使用测试环境;为 “false” 时表示使用正式环境。
  • 针对 2021-09-30 之后注册 ZEGO 控制台 的用户:

    • 控制台分配的 AppID 和 AppSign 等信息都为正式环境。
    • createEngine 接口中的 “isTestEnv” 参数取值必须修改为 “false”,表示使用正式环境。
/** 定义 SDK 引擎对象 */
ZegoExpressEngine engine;

/** 填写 appID 和 appSign */
long appID = ;  /** 请通过官网注册获取,格式为 123456789L */
String appSign = ;  /** 64个字符,请通过官网注册获取,格式为"0123456789012345678901234567890123456789012345678901234567890123" */

/** 创建引擎,使用测试环境,通用场景接入 */
engine = ZegoExpressEngine.createEngine(appID, appSign, true, ZegoScenario.GENERAL, getApplication(), null);  

3.2 登录房间

1. 登录

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

  • 同一个 AppID 内,需保证 “roomID” 全局唯一。
  • 同一个 AppID 内,需保证 “userID” 全局唯一,建议开发者将其设置成一个有意义的值,可将 “userID” 与自己业务账号系统进行关联。
  • ZegoUser 的构造方法 public ZegoUser(String userID) 会将 “userName” 设为与传的参数 “userID” 一样。“userID” 与 “userName” 不能为 “null” 否则会导致登录房间失败。
/** 创建用户 */
ZegoUser user = new ZegoUser("user1");

/** 开始登录房间 */
engine.loginRoom("room1", user);    

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

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

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

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

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

  • onRoomStreamUpdate:流状态更新回调。登录房间后,当房间内有用户新推送或删除音视频流时,SDK 会通过该回调通知。
  • 只有调用 loginRoom 接口登录房间时传入 ZegoRoomConfig 配置,且 “isUserStatusNotify” 参数取值为 “true” 时,用户才能收到 onRoomUserUpdate 回调。
  • 通常情况下,如果某个用户想要播放其他用户推送的视频,可以在收到流状态更新(新增)的回调中,调用 startPlayingStream 接口拉取远端推送的音视频流。
engine.setEventHandler(new IZegoEventHandler() {

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

    /** 房间状态更新回调 */
    @Override
    public void onRoomStateUpdate(String roomID, ZegoRoomState state, int errorCode, JSONObject extendedData) {
        /** 根据需要实现事件回调 */
    }

    /** 用户状态更新回调 */
    @Override
    public void onRoomUserUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoUser> userList) {
        /** 根据需要实现事件回调 */
    }

    /** 流状态更新回调 */
    @Override
    public void onRoomStreamUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoStream> streamList, JSONObject extendedData){
        /** 根据需要实现事件回调 */
     }

});

3.3 推流

1. 开始推流

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

同一个 AppID 内,需保证 “streamID” 全局唯一。如果同一个 AppID 内,不同用户各推了一条 “streamID” 相同的流,会导致后推流的用户推流失败。

/** 开始推流 */
engine.startPublishingStream("stream1");

2. (可选)启用本地预览

设置预览视图并启动本地预览

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

/**
 *  启动预览,设置本地预览视图,视图模式采用 SDK 默认的模式,等比缩放填充整个 View
 *  如下 preview_view 为 UI 界面上的 SurfaceView/TextureView/SurfaceTexture 对象
 */
engine.startPreview(new ZegoCanvas(preview_view));

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

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

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

engine.setEventHandler(new IZegoEventHandler() {
    /** 常用的推流相关回调 */

    /** 推流状态更新回调 */
    @Override
    public void onPublisherStateUpdate(String streamID, ZegoPublisherState state, int errorCode, JSONObject extendedData){
        /** 根据需要实现事件回调 */
    }
});

3.4 拉流

1. 开始拉流

调用 startPlayingStream 接口,根据传入的流 ID 参数 “streamID”,拉取远端推送的音视频流。

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

支持以下类型的控件进行拉流播放:SurfaceView、TextureView 和 SurfaceTexture。

/**
 *  开始拉流,设置远端拉流渲染视图,视图模式采用 SDK 默认的模式,等比缩放填充整个 View
 *  如下 play_view 为 UI 界面上的 SurfaceView/TextureView/SurfaceTexture 对象
 */
engine.startPlayingStream("stream1", new ZegoCanvas(play_view));

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

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

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

engine.setEventHandler(new IZegoEventHandler() {
    /** 常用的拉流相关回调 */

    /** 拉流状态相关回调 */
    @Override
    public void onPlayerStateUpdate(String streamID, ZegoPlayerState state, int errorCode, JSONObject extendedData){
        /** 根据需要实现事件回调 */
    }
});

3.5 体验实时音视频功能

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

通过 Web 端调试示例 (只支持在测试环境下使用),输入相同的 AppID 和 roomID,加入同一房间与真机设备互通。当成功开始音视频通话时,可以同时听到本端和远端音频,看到本端和远端视频画面。

纯音频场景下只能听到音频,看不到视频画面。

3.6 停止推拉流

1. 停止推流/预览

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

/** 停止推流 */
engine.stopPublishingStream();

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

/** 停止本地预览 */
engine.stopPreview();

2. 停止拉流

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

/** 停止拉流 */
engine.stopPlayingStream(streamID);

3.7 退出房间

调用 logoutRoom 接口退出房间。

/** 退出房间 */
engine.logoutRoom("room1");

3.8 销毁引擎

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

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

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

/** 销毁 SDK */
ZegoExpressEngine.destroyEngine(null);

相关文档