AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页 视频直播 开发参考 API参考 API目录 实时音视频 旁路转推 UpdateLiveMPUTask - 更新混流转推任务（新）

UpdateLiveMPUTask - 更新混流转推任务（新）

更新时间：
产品详情
我的收藏

更新混流转推任务。

接口说明

调用本接口前，您必须已经调用 StartLiveMPUTask 创建混流转推任务。

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:UpdateLiveMPUTask

update

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
AppId

string

是

应用 ID，仅支持传单个 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。

yourAppId
ChannelId

string

是

频道 ID，仅支持传单个 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。

yourChannelId
TaskId

string

是

任务 ID，仅支持传单个 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 55 字符。此 ID 为旁路转推的标识，需保证唯一。

yourTaskId
MixMode

string

否

混流模式。取值：

  • 0：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。

  • 1（默认值）：混流转码转推。

0
StreamURL

string

否

直播推流地址，仅支持 RTMP 协议，仅支持传单个地址，最大长度不超过 2048 个字符。生成规则请参见推流地址和播放地址。

说明

  • 对已开防盗链鉴权的域名，需要在推流地址中包含鉴权串。

  • 禁止同一个 StreamURL 在不同任务中同时使用。

  • 任务停止 10S 之内，禁止使用同一个 StreamURL。

rtmp://example.com/live/stream
MultiStreamURL

array<object>

否

多地址转推参数，可填写多个直播推流地址。

object

否

URL

string

否

直播推流地址，仅支持 RTMP 协议，最大长度不超过 2048 个字符。生成规则请参见推流地址和播放地址。

rtmp://example.com/live/stream****
IsAliCdn

boolean

否

是否转推到阿里云 CDN。

  • false 为转推非阿里云 CDN。

  • true 为转推阿里云 CDN。

说明

该参数默认为 false。

false
SingleSubParams

object

否

单流转推参数，单流转推（MixMode=0）时必填。

SourceType

string

否

单流转推模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：

  • camera（默认值）：摄像头。

  • shareScreen：屏幕共享。

camera
StreamType

string

否

单流转推模式下转推流类型。取值：

  • 0（默认值）：转推原始流。

  • 1：仅转推音频流。

  • 2：仅转推视频流。

0
UserId

string

是

转推用户 ID，一次只能转推一路流。

yourSubUserId
TranscodeParams

object

否

混流转码转推参数，混流转码转推（MixMode=1）时必填。

Background

object

否

混流全局背景图。

RenderMode

string

否

子画面输出时的显示模式：

  • 0：缩放并显示黑底。

  • 1（默认）：裁剪。

1
URL

string

否

全局背景图 URL。

yourImageUrl
EncodeParams

object

否

转推输出的编码参数。

AudioOnly

string

否

是否为纯音频，取值：

  • true：纯音频，仅需要设置音频相关参数。

  • false（默认值）：非纯音频，除 VideoCodec 参数与 EnhancedParam 参数外，其它参数均不能为空。

false
AudioBitrate

string

否

音频码率，取值范围：[8, 500]，单位：kbps。

128
AudioChannels

string

否

音频声道数，取值：1、2。

2
AudioSampleRate

string

否

音频采样率，取值：8000、16000、32000、44100、48000，单位：Hz。

44100
VideoCodec

string

否

视频编码格式。取值：

  • H.264（默认值）。

  • H.265。

H.264
VideoBitrate

string

否

视频码率，取值范围：[1, 10000]，单位：kbps。

3500
VideoFramerate

string

否

视频帧率，取值范围：[1, 60]，单位：fps。

25
VideoGop

string

否

视频 GOP，取值范围：[1, 60]。

20
VideoHeight

string

否

视频高，取值范围：[0, 1920]，单位：px。

1000
VideoWidth

string

否

视频宽，取值范围：[0, 1920]，单位：px。

1920
EnhancedParam

string

否

编码增强参数，JSON 字符串，目前支持的可选配置包括 profile 与 preset。

  • profile：编码级别。当视频编码格式为 H.264 时，profile 支持的可选值包括："baseline", "main", "high"；当视频编码格式为 H.265 时，profile 支持的可选值包括："main"。

  • preset：调节编码速度和质量的平衡。preset 支持的可选值包括："ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow" "placebo"。每个值代表了一种编码速度与输出视频质量的策略，从"ultrafast"（极快，编码速度优先）到"placebo"（追求极致质量，编码极慢）。

说明

例如设置 superfast，主要用于实时通讯领域。建议非编码器专业技术人员，不设置该选项。

{"profile": "high", "preset": "veryfast"}
Layout

object

否

视频布局信息。

说明

视频转码时，需要指定视频布局信息，包括布局坐标(X，Y)，布局窗格(Width，Height)，叠放顺序(ZOrder)；纯音频转码时，禁止填写视频布局信息。

UserPanes

array<object>

否

混流用户窗格信息。

array<object>

否

混流用户窗格信息。

UserInfo

object

否

该窗格对应的混流用户信息，不填时后台按照上行主播的进房顺序自动填充。

说明

  • 如果指定混流用户信息，该用户信息需要已在 TranscodeParams.UserInfos 参数中配置。

  • 仅针对原始流和视频流有效。

SourceType

string

否

混流转码模模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：

  • camera（默认值）：摄像头。

  • shareScreen：屏幕共享。

camera
ChannelId

string

否

混流用户所在的频道 ID，同频道内混流的用户可不填，跨频道混流时建议填写该参数。

yourChannelId
UserId

string

否

混流用户 ID。

yourSubUserId
Height

string

否

窗格高，归一化百分比。

0.2632
Width

string

否

窗格宽，归一化百分比。

0.3564
X

string

否

坐标 X，归一化百分比。

0.2456
Y

string

否

坐标 Y，归一化百分比。

0.3789
ZOrder

string

否

叠放顺序，0 为最底层，1 层在 0 层之上，以此类推。

0
BackgroundImageUrl

string

否

子画面的背景图 URL。当用户关闭摄像头或未进入房间时，会在布局位置填充为此图片。

yourImageUrl
RenderMode

string

否

子画面输出时的显示模式，取值：

  • 0：缩放并显示黑底。

  • 1（默认值）：裁剪。

1
UserInfos

array<object>

否

混流时订阅的用户信息，不指定用户则所有用户混流。

object

否

混流用户信息。

SourceType

string

否

混流时订阅的视频输入流类型，仅针对视频流（StreamType=2）有效。取值：

  • camera（默认值）：摄像头。

  • shareScreen：屏幕共享。

camera
StreamType

string

否

混流时订阅的转推流类型。取值：

  • 0（默认值）：转推原始流。

  • 1：仅转推音频流。

  • 2：仅转推视频流。

0
ChannelId

string

否

混流时订阅用户所在的频道 ID，同频道内混流的用户可不填，跨频道混流时建议填写该参数。

yourChannelId
UserId

string

是

混流时订阅的用户 ID。

yourSubUserId
SeiParams

object

否

SEI 配置参数。

LayoutVolume

object

否

布局和音量 SEI，该参数内容可以为空，表示携带默认的布局和音量 SEI。

FollowIdr

string

否

发送 IDR 关键帧时是否确保携带 SEI，取值：

  • 0：不确保带 SEI。

  • 1：确保带 SEI。

0
Interval

string

否

SEI 发送间隔，取值范围：[1000, 5000]，单位：毫秒。

1000
PassThrough

object

否

透传 SEI。

FollowIdr

string

否

发送 IDR 关键帧时是否确保携带 SEI，取值：

  • 0：不确保带 SEI。

  • 1：确保带 SEI。

0
Interval

string

否

SEI 发送间隔，取值范围：[1000, 5000]，单位：毫秒。

1000
PayloadContent

string

否

透传 SEI 的 payload 内容。

yourPayloadContent
PayloadContentKey

string

否

透传 SEI 的 payload 内容对应的 key 值。不设置时，key 为默认值 udd。

yourPayloadContentKey

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

0F72851F-5DC1-1979-9B2C-450040316C3E

示例

正常返回示例

JSON格式

{
  "RequestId": "0F72851F-5DC1-1979-9B2C-450040316C3E"
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidParam %s. 参数校验失败
400 InvalidAppId %s, please check and try again later. AppId无效，请检查后重试。
400 MissingParam %s, please check and try again later. 参数缺失，请检查后重试。
500 InternalError InternalError
403 OperationDenied Your account has not enabled the Live service
403 Forbidden %s, please check and try again later. 无权限，请检查后重试。

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

变更历史

更多信息，参考变更详情。

上一篇：StartLiveMPUTask - 创建混流转推任务（新）下一篇：StopLiveMPUTask - 停止混流转推任务（新）