录制混流

---

1 功能简介

本地服务端录制 SDK 支持将房间内的所有用户的音视频流混合成一个画面再录制，集成 SDK 后，即可开始使用 SDK 的混流录制功能。

2 前提条件

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

3 使用步骤

3.1 设置回调监听

在初始化之前需要先继承实现 ICallback，并设置回调监听。

• 接口原型：

  ZEGO_API bool SetCallback(ICallback* pCB)

• 参数：

  pCB：回调对象指针。

• 备注：

  在初始化 SDK 前可以根据需要调用如下接口：

  SetLogDirAndSize 设置日志文件路径和大小

3.2 初始化 SDK

调用 InitSDK 接口初始化 SDK，将申请到的 AppID 传入参数 “uiAppID”。

• 接口原型：

  ZEGO_API bool InitSDK(unsigned int uiAppID)

• 参数：

  uiAppID：ZEGO 派发的数字 ID，各个开发者的唯一标识。

• 异步回调接口：

  class ICallback
  {
  public:
      virtual void OnInitSDK(int errorCode) {}
  }

  errorCode == 0 表示初始化成功。

3.3 设置 token

在登录房间之前调用 SetCustomToken 接口将 Token 传入 SDK。

• 接口原型：

  ZEGO_API void SetCustomToken(const char *thirdPartyToken)

• 参数：

  thirdPartyToken：鉴权 Token。

3.4 登录房间

录制之前需要先登录房间。

• 接口原型：

  ZEGO_API bool LoginRoom(const char* pszRoomID)

• 参数：

  pszRoomID：房间 ID，正在推流的房间的 ID。

• 异步回调接口：

  class ICallback
  {
  public:
      virtual void OnLoginRoom(int errorCode, const char *pszRoomID) = 0;
  }

3.5 开始录制

1. 此接口必须在初始化成功后调用。
2. 建议在登录房间后并收到 OnStreamUpdate 流信息更新回调后，根据增加流信息来开启录制。
3. 可在开始录制之前调用 GetMaxRecordCount 获取 SDK 支持的最大同时录制流数，根据其值处理同时录制的流数量。

• 接口原型：

  ZEGO_API bool StartRecordMixStream(ZegoMixStreamRecordConfig* pConfig)

• 参数：

  pConfig：混流录制配置，请参考 ZegoMixStreamRecordConfig。

• 异步回调接口：

  class ICallback
  {
  public:
      virtual void OnStreamRecordBegin(const char* pszStreamID, const char *pszPathAndName) = 0;
      virtual void OnMixStreamRecordUpdate(const char** ppszStreamID, int nStreamCount) = 0;
  }

  录制启动成功会收到 OnStreamRecordBegin 回调，成功拉到有音视频数据的流时会收到 OnMixStreamRecordUpdate 回调。

• 备注：

  若需要同时录制单流和混流，在开始录制之前调用 EnableSingleAndMixRecordMode 启用单流混流同时录制模式；此种模式比较消耗系统资源，且只能先启动混流录制，然后再启动单流录制；结束混流录制时也会同时结束所有的单流录制。此种模式下，SDK 有一个限制，混流录制会混入所有单流录制正在录制的流，即使没有将单流录制中的某单流作为混流的输入流，若此单流有音频，这个音频也会被混流录制给录制下来。

3.6 更新混流配置

当需要增加输入流、原输入流变更或者混流输出配置变更时，重新构造混流配置并调用更新混流配置接口。

• 接口原型：

  ZEGO_API bool UpdateInputStreamConfig(ZegoStreamConfig* pInputStream, int nInputStreamCount)

• 异步回调接口：

  class ICallback
  {
  public:
      virtual void OnMixStreamRecordUpdate(const char** ppszStreamID, int nStreamCount) = 0;
  }

  混流成功后会返回包含参与混流录制的单流 ID 列表的回调，只包括成功拉到数据的流 ID。 注意：参与混流录制的流发生变化比如开始录制、录制中流发生异常等都会收到此回调。

3.7 停止录制

• 接口原型：

  ZEGO_API bool StopRecordMixStream()

• 异步回调接口：

  class ICallback
  {
  public:
      virtual void OnStreamRecordEnd(const char* pszStreamID, const char *pszPathAndName, RecordEndReason reason) = 0;
  }

• 备注：

  建议在不需要再录制的时候，做以下处理：

  1. 调用 LogoutRoom 退出房间。
  2. 调用 LIVEROOM::SetCallback(nullptr); 去掉回调监听。
  3. 调用 UnInitSDK 反初始化 SDK。

4 API 参考列表