创建合流任务。
接口说明
云端合流属于收费功能,当前为公测阶段,您可以免费使用,公测结束后将正常收费,具体时间另行通知。
调用本接口创建合流任务,目前本接口支持的布局类型为预设布局和自定义布局。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:CreateMixStream |
create |
*Domain
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
DomainName |
string |
是 |
主播流域名。 重要
目前仅支持华东 2(cn-shanghai)和华北 2(cn-beijing)两个区域的域名。 |
example.com |
LayoutId |
string |
是 |
布局 ID。取值:
说明
更多信息请参见合流预设布局参考 |
MixStreamLayout-1-1 |
InputStreamList |
string |
是 |
合流输入列表。JSON 数组。 参考下方的 InputStreamConfig。 |
[{"LayoutChildId":1,"ResourceType":"live","ResourceValue":"rtmp://example.net/live/f2139ec2b8d6a191068cd****ea9064d?auth_key=1600947017-0-0-0b5645fe35d21a65ab92b394bd4d****","LayoutConfig":{"FillMode":"fit","PositionRefer":"topLeft","FillPositionNormalized":[0,0],"FillSizeNormalized":[1,1]}}] |
OutputConfig |
string |
是 |
合流输出配置。格式为 JSON 字符串。 参考下方的 OutputConfig。 |
{"AppName":"liveApp****","StreamName":"9a78fb3f5c508be0122746f677a3****","MixStreamTemplate":"lp_hd_v","ExpireDuration":"86400"} |
CallbackConfig |
string |
否 |
回调地址。JSON 数组。 当事件产生时,直播服务端会向该地址发起 HTTP POST 请求,具体内容将通过 HTTP Body 送达。 |
{"CallbackUrl":"http://aliyundoc.com"} |
InputStreamConfig
名称 | 类型 | 描述 |
ResourceType | String | 资源类型。 |
ResourceValue | String | 资源地址。 |
LayoutChildId | String | 布局方格对应 ID(也代表合流的叠加顺序)。 |
LayoutConfig | LayoutConfig[] | JSON 数组,代表所在位置、填充方式等布局信息。 |
LayoutConfig
名称 | 类型 | 必选 | 描述 |
FillSizeNormalized | JSON 浮点数组 | 必选 | 表示该 Layer 元素需要填充的尺寸大小。 |
FillPositionNormalized | 浮点数数组 | 必选 | 表示该 Layer 元素填充区位置归一化值。 |
PositionRefer | 字符串 | 可选 | 设置元素的 position 参考坐标值。 |
FillMode | 字符串 | 可选 | 设置元素填充方式。 |
OutputConfig
名称 | 类型 | 必选 | 描述 |
AppName | String | 是 | 输出 App 名。不支持#、?等特殊字符。 |
StreamName | String | 是 | 输出流名。不支持#、?等特殊字符。 |
MixStreamTemplate | String | 是 | 合流输出规格模板 ID (在传参时仅传模板 ID,例如 lp_ld)。 |
ExpireDuration | Long | 可选 | 任务过期时间。单位:秒。取值范围:1~31536000(1 年)。 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
MixStreamId |
string |
合流任务 ID。可作为查询合流任务列表和删除合流任务的请求参数。 |
5b2a046e-74d7-385e-253f-8a5b87e4**** |
RequestId |
string |
请求 ID。 |
0D715397-2E66-4AE1-694h-C546628AD145 |
示例
正常返回示例
JSON
格式
{
"MixStreamId": "5b2a046e-74d7-385e-253f-8a5b87e4****",
"RequestId": "0D715397-2E66-4AE1-694h-C546628AD145"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidUserId.Malformed | %s | |
400 | InvalidParameter.Malformed | %s | |
400 | MissingParameter | %s | |
401 | IllegalOperation | %s | |
500 | InternalError | %s | |
403 | MixStreamAlreadyExist | %s | |
403 | MixStreamNotExist | %s | |
403 | UserQuotaExceed | %s | |
404 | InvalidDomainName.NotFound | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。