开始自动混流

1 简介

本文介绍如何调用服务端 API 接口，指定房间，自动将房间内的所有 音频 流进行混流。可以应用在语聊房、合唱等场景中。

在跨房间 PK 连麦等场景中，支持增加其他房间内的某条流，参与自动混流；或剔除当前房间的某条流，不参与自动混流，具体请参考 4 请求参数 中的 ExtraMixInput 参数说明。

“客户端”的混流功能，请参考 混流 - 自动混流；“服务端”的相关回调，请参考 混流开始回调 和 混流结束回调。

2 前提条件

在实现混流之前，请确保：

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppId 和 ServerSecret，详情请参考 控制台 - 项目信息。
• 已在 ZEGO 控制台 自助接入服务开通“混流”服务权限，详情请参考 控制台 - 服务配置 - 混流，或联系 ZEGO 技术支持开通。
• 已通过开发者自己的客户端，在房间内发起推拉流，详情请参考 实现视频通话。
• 若您希望创建自动混流时，如果房间不存在，可自动创建对应房间，请联系 ZEGO 技术支持开启相关功能。

3 接口原型

• 请求方法：POST

  使用 POST 请求方法传递参数时：

  • Body 中的参数直接传 JsonObject 格式即可，无需序列化为 String 格式。
  • Headers 中，设置 “Content-type” 为 “application/json”。

• 请求地址：https://rtc-api.zego.im/?Action=StartAutoMix

• 传输协议：HTTPS

• 调用频率限制：100 次/秒

• 请求示例：

  https://rtc-api.zego.im/?Action=StartAutoMix
  &AppId=1234567890
  &SignatureNonce=15215528852396
  &Timestamp=1234567890
  &Signature=7a2c0f11145fb760d607a07b54825013
  &SignatureVersion=2.0
  &IsTest=false

4 请求参数

此接口中只有部分参数在开始混流后支持动态更新，未标注的则不支持动态更新，详情请参考下表中的参数描述。

{
    "TaskId": "2213699902971205739", 
    "UserId": "123",
    "RoomId": "room123",
    "MixOutput": [
        {
            "StreamId": "stream3"
        }
    ]
}

5 响应参数

响应示例如下：

{
    "Code": 0, 
    "Data": {
        "PlayInfo": [
            {
                "FLV": "http://domain/appname/test.flv", 
                "HLS": "http://domain/appname/test/playlist.m3u8", 
                "RTMP": "rtmp://domain/appname/test", 
                "Status": 0, 
                "StreamId": "test", 
                "UserName": ""
            }
        ], 
        "RoomId": "room123", 
        "Sequence": 1, 
        "UserId": "123"
    }, 
    "Message": "success", 
    "RequestId": "8472822294336370476"
}

6 返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考 全局返回码。