UpdateMixStream - 更新合流任务

更新合流任务。

接口说明

调用本接口更新合流任务。本接口目前支持更新输入源以及布局,不支持更新输出分辨率等内容。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:UpdateMixStreamupdate
*Domain
acs:live:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
DomainNamestring

主播流域名。

注意 目前仅支持华东 2(cn-shanghai)和华北 2(cn-beijing)两个区域的域名。

example.com
MixStreamIdstring

合流任务 ID。如果您通过 CreateMixStream 接口创建合流任务,请查看 CreateMixStream 接口调用返回的参数 MixStreamId 值。

5b2a046e-74d7-385e-d2d7-8a5b87e4****
InputStreamListstring

合流输入列表,JSON 数组。

参考下方的 InputStreamConfig

{"InputStreamList":[{"LayoutConfig":{"fillSizeNormalized":[0.5,0.5],"fillPositionNormalized":[0,0],"positionRefer":"topLeft","fillMode":"fit"},"LayoutChildId":1,"ResourceValue":"rtmp://aliyundoc.com/caster/8564a8d1659b4dc69df5f66cf4c9****","ResourceType":"live"},{"LayoutConfig":{"fillSizeNormalized":[0.5,0.5],"fillPositionNormalized":[0.5,0],"positionRefer":"topLeft","fillMode":"fit"},"LayoutChildId":2,"ResourceValue":"http://developer.aliyundoc.com/3c3c25426cf744fdb90423e76b78a28a/69b1a16e2b1d423d9841bf27a96f134e-0b1cba51f58bb5ad3a854x96a2c735f****.mp4","ResourceType":"url"},{"LayoutConfig":{"fillSizeNormalized":[1,0.5],"fillPositionNormalized":[0,0.5],"positionRefer":"topLeft","fillMode":"fit"},"LayoutChildId":3,"ResourceValue":"http://aliyundoc.com/c0c6c5446b56432389e91535864938da/ed4adc5263b4474c954b95607a5350ae-fda757b3328438a8cf-4k57f373a0f0****.mp4","ResourceType":"url"}]}
LayoutIdstring

布局 ID。支持:

  • MixStreamLayout-1-1
  • MixStreamLayout-2-1
  • MixStreamLayout-2-2
  • MixStreamLayout-2-3
  • MixStreamLayout-3-1
  • MixStreamLayout-3-2
  • MixStreamLayout-4-1
  • USERDEFINED(非上述预设布局,取固定值 USERDEFINED
说明 更多信息请参见合流预设布局参考
MixStreamLayout-3-2

InputStreamConfig

名称类型描述
ResourceTypeString资源类型。
live:直播流地址。
url:文件流地址。
ResourceValueString资源地址。
如果 ResourceType 为 live,则为直播流地址。直播流地址支持 RTMP、FLV 和 ARTC 协议,不支持 HLS 协议。
如果 ResourceType 为 url,则为文件流地址。
LayoutChildIdString布局方格对应 ID(也代表合流的叠加顺序)。
LayoutConfigLayoutConfig[]JSON 数组,代表所在位置、填充方式等布局信息。
如果使用预设布局,则此参数可以不填。
如果设置了该值,则忽略 LayoutChildId 对应的预设布局信息。

返回参数

名称类型描述示例值
object
MixStreamIdstring

合流任务 ID。可作为查询合流任务列表和删除合流任务的请求参数。

5b2a046e-74d7-385e-d2d7-8a5b87e4****
RequestIdstring

请求 ID。

1A8CDDFF-0121-4ABB-DA60-AEF095A8W34F

示例

正常返回示例

JSON格式

{
  "MixStreamId": "5b2a046e-74d7-385e-d2d7-8a5b87e4****",
  "RequestId": "1A8CDDFF-0121-4ABB-DA60-AEF095A8W34F"
}

错误码

HTTP status code错误码错误信息
400InvalidUserId.Malformed%s
400InvalidParameter.Malformed%s
400MissingParameter%s
401IllegalOperation%s
403MixStreamAlreadyExist%s
403MixStreamNotExist%s
404InvalidDomainName.NotFound%s
500InternalError%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史

SDK 示例

详细示例,请参见合流代码示例