实时音视频
  • iOS
  • Android : Java
  • macOS
  • Windows
  • HarmonyOS
  • Linux
  • Web
  • 小程序
  • Flutter
  • Electron
  • Unreal Engine
  • Unity3D
  • uni-app
  • React Native
  • Cocos Creator
  • 产品简介
  • 下载
  • 体验 App
  • 快速开始
    • 跑通示例源码
    • 集成 SDK
    • 实现视频通话
    • 场景化音视频配置
  • 通信能力
  • 房间能力
  • 音频能力
  • 视频能力
  • 直播能力
  • 其他能力
  • 最佳实践
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • 实时音视频
  • 最佳实践
  • 多人视频通话

多人视频通话

更新时间:2024-01-04 20:26

功能简介

本文展示了如何使用 ZEGO Express SDK 构造多人视频通话场景,即实现多对多实时音视频互动。用户可在房间内与其余用户进行实时视频通话,互相推拉流。该场景可用于多人实时视频聊天、视频会议等。

前提条件

在应用多人视频通话场景之前,请确保:

示例源码下载

请参考 下载示例源码 获取源码。

相关源码请查看 “/ZegoExpressExample/Scenes/src/main/java/im/zego/Scenes/VideoForMultipleUsers” 目录下的文件。

使用步骤

本节将介绍如何使用 ZEGO Express SDK 实现多人视频通话。

  • 多人视频通话的流程图如下:
  • API 调用时序图如下:

ZEGO Express SDK 可支持多人视频通话,如上时序图以 2 名房间成员间的实时视频通话为例,建议开发者参考上述流程设计自己的多人实时视频通话场景。

1 创建引擎

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

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

// 定义 SDK 引擎对象
ZegoExpressEngine engine;

ZegoEngineProfile profile = new ZegoEngineProfile();
// 请通过官网注册获取,格式为 123456789L
profile.appID = appID;
// 64 个字符,请通过官网注册获取,格式为"0123456789012345678901234567890123456789012345678901234567890123"
profile.appSign = appSign;
// 通用场景接入
profile.scenario = ZegoScenario.DEFAULT;
// 设置app的application 对象
profile.application = getApplication();
// 创建引擎
engine = ZegoExpressEngine.createEngine(profile, null);

2 开启房间内用户变化通知

开发者需在每位用户登录房间时将 ZegoRoomConfig 中的 “isUserStatusNotify” 设为 “true”,用于接收其他用户进出房间的回调通知。

ZegoRoomConfig RoomConfig = new ZegoRoomConfig();
RoomConfig.isUserStatusNotify = true;
// 登录房间
engine.loginRoom(roomID, user, RoomConfig);

3 预览自己的画面,并推送到远端

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

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

“streamID” 由您本地生成,但是需要保证:同一个 AppID 下,“streamID” 全局唯一。如果同一个 AppID 下,不同用户各推了一条 “streamID” 相同的流,会导致后推流的用户推流失败。

// 进行预览和推流
// preview 为一个View 对象,开发者可以根据业务自定义,一般常用的是 TextureView 对象
engine.startPreview(new ZegoCanvas(preview));
// 用户本端的 StreamID
engine.startPublishingStream("YOUR_STREAM_ID");

4 拉取音视频流

4.1 拉取其他用户的音视频

进行视频通话时,我们需要拉取到其他用户的音视频。

onRoomStreamUpdate :在同一房间内的其他用户将音视频流推送到 ZEGO 音视频云时,我们会在此回调中收到音视频流新增的通知。

我们可以在该回调中,调用 startPlayingStream,传入 “streamID” 拉取播放该用户的音视频。您可通过监听 onPlayerStateUpdate 回调知晓是否成功拉取音视频。

4.2 展示用户进出房间的信息

onRoomUserUpdate 回调可以用于监听房间内的用户变化,房间内其他用户进入或退出都会触发该回调。

房间人数大于 500 人的情况下 onRoomUserUpdate 回调不保证有效。若业务场景存在房间人数大于 500 的情况,不应依赖于该回调设计业务逻辑。若有在房间人数大于 500 时使用该回调的需求,请联系 ZEGO 技术支持。

代码示例如下:

engine.setEventHandler(new IZegoEventHandler() {
    @Override
    public void onRoomUserUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoUser> userList) {
        super.onRoomUserUpdate(roomID, updateType, userList);
        // 房间用户变化回调,本示例是以 toast 为展示示例,实际业务流程需开发者按需设计
        if(updateType == ZegoUpdateType.ADD){
            // 当 “updateType” 为 “ZegoUpdateTypeADD” 时,用户可以拉取 userList 里的用户进行处理
            for(ZegoUser user : userList){
                // 进行 Toast 展示
                // myActivity 为一个 content 对象,若在 activity 中可使用该 Activity 为参数
                Toast.makeText(myActivity,user.userID+"加入房间",Toast.LENGTH_SHORT).show();
            }
        }else{
            // 当 “updateType” 为 “ZegoUpdateTypeDelete” 时,用户可以拉取 userList 里的用户进行处理
            for(ZegoUser user : userList){
                // 进行 Toast 展示
                // myActivity 为一个 content 对象,若在 activity 中可使用该 Activity 为参数
                Toast.makeText(myActivity,user.userID+"加入房间",Toast.LENGTH_SHORT).show();
            }
        }
    }
    @Override
    public void onRoomStateUpdate(String roomID, ZegoRoomState state, int errorCode, JSONObject extendedData) {
        // 房间状态回调
        super.onRoomStateUpdate(roomID, state, errorCode, extendedData);
        if(state == ZegoRoomState.CONNECTED){
            // 可以根据实际业务进行设计
        }
    }
    @Override
    public void onRoomStreamUpdate(String roomID, ZegoUpdateType updateType, ArrayList< ZegoStream > streamList, JSONObject extendedData) {
        // 流变化回调
        super.onRoomStreamUpdate(roomID, updateType, streamList, extendedData);
        // 在这里更新 UI 或执行其他操作
        if(updateType == ZegoUpdateType.ADD){
            // 当 “updateType” 为 “ZegoUpdateTypeADD” 时,用户可以拉取 streamList 里各条音视频流以展示房间内其他用户的画面和声音
            for(ZegoStream stream : streamList){
                // 进行拉流,preview 为一个 View 对象,开发者可以根据业务自定义,一般常用的是 TextureView 对象;在展示多人视频的时候,开发者需要使用不同的 View 承载不同音视频流的画面,保证不同用户的视频不会重叠在一起;此处的示例代码会覆盖当前正在拉流的画面
                engine.startPlayingStream( stream.streamID,new ZegoCanvas(preview));
            }
        }else{
            // 当 “updateType” 为 “ZegoUpdateTypeDELETE” 时,用户可以停止拉取相应的音视频流
            for(ZegoStream stream : streamList){
                // 停止拉流
                engine.stopPlayingStream( stream.streamID);
            }
        }
    }
});

5 停止视频通话

通话过程中,房间内的用户如果需要结束通话,请参考 快速开始 - 实现流程 依次完成相关操作。

本篇目录