实现视频通话

---

1 功能简介

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

相关概念解释:

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

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

2 前提条件

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

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

3 使用步骤

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

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

3.1 设置动态库路径

定义 SDK 引擎对象，调用 setEngineConfig 接口，将 SDK 动态库的路径传给 SDK，设置引擎进阶配置。

ZegoEngineConfig zegoEngineConfig = new ZegoEngineConfig();
zegoEngineConfig.advancedConfig.put("native_library_path", "path/lib/libZegoExpressEngine.so");
ZegoExpressEngine.setEngineConfig(zegoEngineConfig);

3.2 创建引擎

调用 createEngine 接口，将申请到的 AppID 和 AppSign 传入参数 “appID” 和 “appSign”。

根据 App 实际的音视频业务选择一个合适的场景，请参考 场景化音视频配置 文档，把选择好的场景枚举传入参数 "scenario"。

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

// 创建引擎，通用场景接入，并注册 self 为 eventHandler 回调
// 不需要注册回调的话，eventHandler 参数可以传 null，后续可调用 "setEventHandler:" 方法设置回调
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;  // 请通过官网注册获取，格式为：1234567890L
profile.appSign = appSign;// 请通过官网注册获取，格式为：“0123456789012345678901234567890123456789012345678901234567890123”（64个字符）
profile.scenario = ZegoScenario.BROADCAST;  // 指定使用直播场景 (请根据实际情况填写适合你业务的场景)
profile.application = getApplication();
engine = ZegoExpressEngine.createEngine(profile, null);

3.3 登录房间

1. 登录

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

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

/** 创建用户 */
// ZegoUser 的构造方法 public ZegoUser(String userID) 会将 “userName” 设为与传的参数 “userID” 一样。“userID” 与 “userName” 不能为 “null” 否则会导致登录房间失败。 
ZegoUser user = new ZegoUser("user1");
// 只有传入 “isUserStatusNotify” 参数取值为 “true” 的 ZegoRoomConfig，才能收到 onRoomUserUpdate 回调。
ZegoRoomConfig roomConfig = new ZegoRoomConfig();
// 如果您使用 appsign 的方式鉴权，token 参数不需填写；如果需要使用更加安全的 鉴权方式： token 鉴权，请参考[如何从 AppSign 鉴权升级为 Token 鉴权](https://doc-zh.zego.im/faq/token_upgrade?product=ExpressVideo&platform=all)
// roomConfig.token = "xxxx";
roomConfig.isUserStatusNotify = true;
// 登录房间
engine.loginRoom("room1", user, roomConfig, (int error, JSONObject extendedData)->{
    // (可选回调) 登录房间结果，如果仅关注登录结果，关注此回调即可
});

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

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

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

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

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

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

engine.setEventHandler(new IZegoEventHandler() {

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

    /** 房间状态更新回调 */
    @Override
    public void onRoomStateChanged(String roomID, ZegoRoomStateChangedReason reason, int errorCode, JSONObject extendedData) {
        if(reason == ZegoRoomStateChangedReason.LOGINING)
        {
            // 登录中
        }
        else if(reason == ZegoRoomStateChangedReason.LOGINED)
        {
            // 登录成功
            //只有当房间状态是登录成功或重连成功时，推流（startPublishingStream）、拉流（startPlayingStream）才能正常收发音视频
            //将自己的音视频流推送到 ZEGO 音视频云
        }
        else if(reason == ZegoRoomStateChangedReason.LOGIN_FAILED)
        {
            // 登录失败
        }
        else if(reason == ZegoRoomStateChangedReason.RECONNECTING)
        {
            // 重连中
        }
        else if(reason == ZegoRoomStateChangedReason.RECONNECTED)
        {
            // 重连成功
        }
        else if(reason == ZegoRoomStateChangedReason.RECONNECT_FAILED)
        {
            // 重连失败
        }
        else if(reason == ZegoRoomStateChangedReason.KICK_OUT)
        {
            // 被踢出房间
        }
        else if(reason == ZegoRoomStateChangedReason.LOGOUT)
        {
            // 登出成功
        }
        else if(reason == ZegoRoomStateChangedReason.LOGOUT_FAILED)
        {
            // 登出失败
        }
    }

    /** 用户状态更新回调 */
    @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.4 推流

1. 开始推流

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

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

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

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

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

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

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

3.5 拉流

1. 开始拉流

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

/**
 *  开始拉流  
 */
engine.startPlayingStream("stream1");

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

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

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

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

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

3.6 体验实时音视频功能

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

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

3.7 停止推拉流

1. 停止推流

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

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

2. 停止拉流

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

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

3.8 退出房间

调用 logoutRoom 接口退出房间。

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

3.9 销毁引擎

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

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

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

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

相关文档

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

• SDK 是否支持断线重连？

• 如何处理房间相关问题？

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

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

• 如何在较差的网络环境中保证音视频流畅？