ListRtcMPUTaskDetail - 查询混流转推任务参数明细 - 视频直播

查询混流转推任务参数明细。

接口说明

本接口用于查询混流转推任务的参数明细，仅可查询通过 API 创建的混流转推任务。
分页查询时，查询结果默认按照任务的更新时间倒序排列。

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID。说明应用 ID 由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。	yourAppId
TaskId	string	否	任务 ID。说明任务 ID 由大小写字母、数字、下划线、短划线（-）组成，最大 55 字符。指定任务 ID 时，优先按任务 ID 查询，返回结果为指定任务 ID 的旁路转推任务的参数明细。	yourTaskId
PageSize	long	否	单页显示记录的数量，取值范围：1~100。说明未指定任务 ID 时，需要指定 PageSize 与 PageNo 参数，此时会返回指定应用 ID 下所有旁路转推任务参数明细的分页查询结果。	10
PageNo	long	否	页码。	20

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	****3B-0E1A-586A-AC29-742247****
MPUTasks	array<object>	任务参数明细，参数明细格式与调用创建混流任务时的参数格式一致。
mpuTask	object
AppId	string	应用 ID。	yourAppId
ChannelId	string	频道 ID。	yourChannelId
TaskId	string	任务 ID，此 ID 为旁路转推任务的标识。	yourTaskId
MixMode	string	混流模式。取值： 0：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。 1（默认值）：混流转码转推。	0
StreamURL	string	直播推流地址。	rtmp://example.com/live/stream****
MultiStreamURL	array<object>	多地址转推参数。
MultiStreamURL	object
URL	string	直播推流地址。	rtmp://example.com/live/stream****
IsAliCdn	boolean	是否转推到阿里云 CDN。 false 为转推非阿里云 CDN。 true 为转推阿里云 CDN。	false
Region	string	请求的混流服务所在区域。取值： CN-Shanghai：上海。 AP-Singapore（默认值）：新加坡。 EMAA-Saudi：沙特。	CN-Shanghai
MaxIdleTime	string	空闲超时时间说明若设置了此参数，则会在任务处于空闲状态的时长大于 MaxIdleTime 时，自动停止该任务；若未设置此参数，则会在房间关闭后，立刻停止该任务。	10
SingleSubParams	object	单流转推参数。
SourceType	string	单流转推模式下视频输入流类型，当视频流（StreamType=2）时有效。取值： camera（默认值）：摄像头。 shareScreen：屏幕共享。	camera
StreamType	string	单流转推模式下转推流类型。取值： 0（默认值）：转推原始流。 1：仅转推音频流。 2：仅转推视频流。	0
UserId	string	转推用户 ID，一次只能转推一路流。	yourSubUserId
TranscodeParams	object	混流转码转推参数。
Background	object	混流全局背景图。
RenderMode	string	子画面输出时的显示模式： 0：缩放并显示黑底。 1（默认）：裁剪。	1
URL	string	全局背景图 URL。	yourImageUrl
EncodeParams	object	转推输出的编码参数。
AudioOnly	string	是否为纯音频，取值： true：纯音频。 false（默认值）：非纯音频。	false
AudioBitrate	string	音频码率，单位：kbps。	128
AudioChannels	string	音频声道数，取值：1、2。	2
AudioSampleRate	string	音频采样率，单位：Hz。	44100
VideoCodec	string	视频编码格式。默认值 H.264。	H.264
VideoBitrate	string	视频码率，单位：kbps。	3500
VideoFramerate	string	视频帧率，单位：fps。	25
VideoGop	string	视频 GOP。	20
VideoHeight	string	视频高，单位：px。	1000
VideoWidth	string	视频宽，单位：px。	1920
EnhancedParam	string	编码增强参数，JSON 字符串，目前支持的可选配置包括 profile 与 preset。 profile：编码级别。当视频编码格式为 H.264 时，profile 支持的可选值包括："baseline", "main", "high"。 preset：调节编码速度和质量的平衡。preset 支持的可选值包括："ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow" "placebo"。每个值代表了一种编码速度与输出视频质量的策略，从"ultrafast"（极快，编码速度优先）到"placebo"（追求极致质量，编码极慢）。	{"profile": "high", "preset": "veryfast"}
Layout	object	视频布局信息。说明视频转码时所指定的视频布局信息，包括布局坐标(X，Y)，布局窗格(Width，Height)，叠放顺序(ZOrder)；纯音频转码时，不包含视频布局信息。
UserPanes	array<object>	混流用户窗格信息。
UserPane	object
UserInfo	object	混流用户信息。
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>	混流用户信息，不指定用户则所有用户混流。
UserInfo	object
ChannelId	string	混流用户所在的频道 ID。	yourChannelId
UserId	string	混流用户 ID。	yourSubUserId
SourceType	string	混流转码模模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值： camera（默认值）：摄像头 shareScreen：屏幕共享。	camera
StreamType	string	混流转码模式下转推流类型。取值： 0（默认值）：转推原始流。 1：仅转推音频流。 2：仅转推视频流。	0
SeiParams	object	SEI 配置参数。
LayoutVolume	object	布局和音量 SEI，该参数内容为空则表示携带默认的布局和音量 SEI。
FollowIdr	string	发送 IDR 关键帧时是否确保携带 SEI，取值： 0：不确保带 SEI。 1：确保带 SEI。	0
Interval	string	SEI 发送间隔，单位：毫秒。	1000
PassThrough	object	透传 SEI。
FollowIdr	string	发送 IDR 关键帧时是否确保携带 SEI，取值： 0：不确保带 SEI。 1：确保带 SEI。	0
Interval	string	SEI 发送间隔，单位：毫秒。	1000
PayloadContent	string	透传 SEI 的 payload 内容。	yourPayloadContent
PayloadContentKey	string	透传 SEI 的 payload 内容对应的 key 值。不设置时，key 为默认值 udd。	yourPayloadContentKey
PayloadType	string	SEI 消息的自定义 payload_type，取值范围 100-254。不设置时，SEI 的 payload_type 为默认值为 5。	100

示例

正常返回示例

JSON格式

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "MPUTasks": [
    {
      "AppId": "yourAppId",
      "ChannelId": "yourChannelId",
      "TaskId": "yourTaskId",
      "MixMode": "0",
      "StreamURL": "rtmp://example.com/live/stream****",
      "MultiStreamURL": [
        {
          "URL": "rtmp://example.com/live/stream****",
          "IsAliCdn": false
        }
      ],
      "Region": "CN-Shanghai",
      "MaxIdleTime": "10",
      "SingleSubParams": {
        "SourceType": "camera",
        "StreamType": "0",
        "UserId": "yourSubUserId"
      },
      "TranscodeParams": {
        "Background": {
          "RenderMode": "1",
          "URL": "yourImageUrl"
        },
        "EncodeParams": {
          "AudioOnly": "false",
          "AudioBitrate": "128",
          "AudioChannels": "2",
          "AudioSampleRate": "44100",
          "VideoCodec": "H.264",
          "VideoBitrate": "3500",
          "VideoFramerate": "25",
          "VideoGop": "20",
          "VideoHeight": "1000",
          "VideoWidth": "1920",
          "EnhancedParam": "{\"profile\": \"high\", \"preset\": \"veryfast\"}"
        },
        "Layout": {
          "UserPanes": [
            {
              "UserInfo": {
                "SourceType": "camera",
                "ChannelId": "yourChannelId",
                "UserId": "yourSubUserId"
              },
              "Height": "0.2632",
              "Width": "0.3564",
              "X": "0.2456",
              "Y": "0.3789",
              "ZOrder": "0",
              "BackgroundImageUrl": "yourImageUrl",
              "RenderMode": "1"
            }
          ]
        },
        "UserInfos": [
          {
            "ChannelId": "yourChannelId",
            "UserId": "yourSubUserId",
            "SourceType": "camera",
            "StreamType": "0"
          }
        ]
      },
      "SeiParams": {
        "LayoutVolume": {
          "FollowIdr": "0",
          "Interval": "1000"
        },
        "PassThrough": {
          "FollowIdr": "0",
          "Interval": "1000",
          "PayloadContent": "yourPayloadContent",
          "PayloadContentKey": "yourPayloadContentKey"
        },
        "PayloadType": "100"
      }
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParam	%s
400	InvalidAppId	%s
403	OperationDenied	Your account has not enabled the Live service
403	Forbidden	%s
404	MissingParam	%s
500	InternalError	InternalError

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

变更历史

变更时间	变更内容概要	操作
2024-11-14	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-10-30	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-06	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-07-04	OpenAPI 错误码发生变更	查看变更详情