有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

该接口用来创建通用混流。用法与旧接口 mix_streamv2.start_mix_stream_advanced 基本一致。
注意:当前最多支持16路混流。
最佳实践:https://cloud.tencent.com/document/product/267/45566

默认接口请求频率限制:200次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCommonMixStream。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
MixStreamSessionId String 混流会话(申请混流开始到取消混流结束)标识 ID。80字节以内,仅含字母、数字以及下划线的字符串。
示例值:test_room
InputStreamList.N Array of CommonMixInputParam 混流输入流列表。
OutputParams CommonMixOutputParams 混流输出流参数。
MixStreamTemplateId Integer 输入模板 ID,若设置该参数,将按默认模板布局输出,无需填入自定义位置参数。
不填默认为0。
两输入源支持10,20,30,40,50。
三输入源支持310,390,391。
四输入源支持410。
五输入源支持510,590。
六输入源支持610。
示例值:40
ControlParams CommonMixControlParams 混流的特殊控制参数。如无特殊需求,无需填写。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 申请混流-使用模板40

使用混流预置模板混流。

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCommonMixStream
<公共请求参数>

{
    "MixStreamTemplateId": 40,
    "MixStreamSessionId": "test_room",
    "InputStreamList": [
        {
            "LayoutParams": {
                "ImageLayer": 1
            },
            "InputStreamName": "test_stream1"
        },
        {
            "LayoutParams": {
                "ImageLayer": 2
            },
            "InputStreamName": "test_stream2"
        }
    ],
    "OutputParams": {
        "OutputStreamName": "test_stream1"
    }
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例2 申请混流-使用自定义布局参数

使用自定义布局。

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCommonMixStream
<公共请求参数>

{
    "InputStreamList": [
        {
            "LayoutParams": {
                "ImageLayer": 1,
                "ImageHeight": 720,
                "ImageWidth": 1280
            },
            "InputStreamName": "test_stream1"
        },
        {
            "LayoutParams": {
                "ImageLayer": 2,
                "ImageHeight": 320,
                "ImageWidth": 240,
                "LocationX": 100,
                "LocationY": 100
            },
            "InputStreamName": "test_stream2"
        }
    ],
    "OutputParams": {
        "OutputStreamName": "test_stream1"
    },
    "MixStreamSessionId": "test_room"
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例3 申请混流-使用裁剪参数

使用裁剪参数。

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCommonMixStream
<公共请求参数>

{
    "InputStreamList": [
        {
            "LayoutParams": {
                "ImageLayer": 1,
                "ImageHeight": 720,
                "ImageWidth": 1280
            },
            "InputStreamName": "test_stream1"
        },
        {
            "LayoutParams": {
                "ImageLayer": 2,
                "ImageHeight": 320,
                "ImageWidth": 240,
                "LocationX": 100,
                "LocationY": 100
            },
            "InputStreamName": "test_stream2",
            "CropParams": {
                "CropWidth": 240,
                "CropHeight": 320,
                "CropStartLocationX": 100,
                "CropStartLocationY": 100
            }
        }
    ],
    "OutputParams": {
        "OutputStreamName": "test_stream1"
    },
    "MixStreamSessionId": "test_room"
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.CallOtherSvrError 调用第三方服务失败。
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
FailedOperation.CancelSessionNotExist 取消的混流 session 不存在。
FailedOperation.GetPictureUrlError 无法获取水印 url。
FailedOperation.GetStreamResolutionError 获取输入流长宽失败。
FailedOperation.ProcessMixError 启动混流失败。
FailedOperation.StreamNotExist 流不存在。
InternalError 内部错误。
InternalError.JiFeiOtherError 计费平台返回其他错误。
InvalidParameter 参数错误。
InvalidParameter.CancelSessionNotExist 取消不存在的会话。
InvalidParameter.InputNumLimitExceeded 输入数目超出限制。
InvalidParameter.InvalidBackgroudResolution 非法的背景长宽。
InvalidParameter.InvalidBitrate 非法的输出码率。
InvalidParameter.InvalidCropParam 裁剪区域溢出原始图片。
InvalidParameter.InvalidLayerParam 图层参数错误。
InvalidParameter.InvalidOutputStreamID 输出流 ID 被占用。
InvalidParameter.InvalidOutputType 非法输出类型,检查 OutputPram-StreamId 与 OutputType 是否匹配。
InvalidParameter.InvalidPictureID 水印 ID 未设置。
InvalidParameter.InvalidRoundRectRadius 非法的圆角矩形圆角半径。
InvalidParameter.OtherError 其他错误。
InvalidParameter.SessionOutputStreamChanged 同一会话输出流发生变化。
InvalidParameter.TemplateNotMatchInputNum 模板与输入流条数不匹配。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。