ListRtcMPUTaskDetail - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the parameters of mixed-stream relay tasks.

Operation description

You can call the ListRtcMPUTaskDetail operation to query the parameters of mixed-stream relay tasks that were created by calling the StartLiveMPUTask operation.
By default, the query results are sorted in reverse chronological order based on the task update time.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:ListRtcMPUTaskDetail

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application. Note The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).	yourAppId
TaskId	string	No	The task ID. Note The ID can be up to 55 characters in length and can contain letters, digits, underscores (_), and hyphens (-). If you specify TaskId, the parameters of the specified tasks are returned.	yourTaskId
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Note If you do not specify TaskId, you must specify PageSize and PageNo. Then, the parameters of all stream relay tasks for the specified application are returned in pages.	10
PageNo	integer	No	The page number.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
MPUTasks	array<object>	The parameters that you configured when you called the StartLiveMPUTask operation to create the tasks.
	array<object>
AppId	string	The ID of the application.	yourAppId
ChannelId	string	The ID of the channel.	yourChannelId
TaskId	string	The ID of the stream relay task.	yourTaskId
MixMode	string	The stream mixing mode. Valid values: 0: relays the original single stream without mixing streams. If the value of this parameter is 0, the TranscodeParams parameter is empty. 1 (default): mixes multiple streams into a single stream and relays the mixed stream.	0
StreamURL	string	The ingest URL.	rtmp://example.com/live/stream****
MultiStreamURL	array<object>	The multiple ingest URLs relayed.
	object
URL	string	The ingest URL.	rtmp://example.com/live/stream****
IsAliCdn	boolean	Indicates whether stream relay is performed by using Alibaba Cloud CDN. Valid values: false: Stream relay is performed by using a CDN service that is not Alibaba Cloud CDN. true: Stream relay is performed by using Alibaba Cloud CDN.	false
Region	string	The region in which the streams are mixed. Valid values: CN-shanghai AP-Singapore (default) EMAA-Saudi	CN-Shanghai
MaxIdleTime	string	The timeout period of an idle connection. Unit: seconds. Note If the task is idle for a period of time longer than the duration specified by the MaxIdleTime parameter, the task is automatically stopped. If the parameter is not specified, the task is stopped after the channel is closed.	10
SingleSubParams	object	The parameters of the single-stream relay task.
SourceType	string	The source of the video. This parameter is valid only if you set StreamType to 2. Valid values: camera (default): captures the video by using a camera. shareScreen: captures the content displayed on a screen.	camera
StreamType	string	The type of the stream that is relayed. Valid values: 0 (default): the original stream. 1: the audio-only stream. 2: the video-only stream.	0
UserId	string	The ID of the user whose stream is relayed. In single-stream relay mode, you can relay only one stream in a request.	yourSubUserId
TranscodeParams	object	The mixed-stream relay parameters.
Background	object	The global background image.
RenderMode	string	The display mode. Valid values: 0: proportionally scales the video or background image to fit the pane. Black bars are added to fill the extra space. 1 (default): crops the video or background image to fit the pane.	1
URL	string	The URL of the global background image.	yourImageUrl
EncodeParams	object	The encoding parameters of the output stream.
AudioOnly	string	Indicates whether the output stream is an audio-only stream. Valid values: true false (default)	false
AudioBitrate	string	The bitrate of the audio. Unit: Kbit/s.	128
AudioChannels	string	The number of audio channels. Valid values: 1 and 2.	2
AudioSampleRate	string	The audio sampling rate. Unit: Hz.	44100
VideoCodec	string	The video encoding format. Default value: H.264.	H.264
VideoBitrate	string	The bitrate of the video. Unit: Kbit/s.	3500
VideoFramerate	string	The frame rate of the video. Unit: frames per second (FPS).	25
VideoGop	string	The group of pictures (GOP) size of the video.	20
VideoHeight	string	The height of the video. Unit: pixels.	1000
VideoWidth	string	The width of the video. Unit: pixels.	1920
EnhancedParam	string	The parameter for advanced video encoding. The value is a JSON string. Optional fields: profile: the encoding level. If the video encoding format is set to H.264, the valid values of this field are baseline, main, and high. preset: adjusts the trade-off between encoding speed and video quality. Valid values: ultrafast, superfast, veryfast, faster, fast, medium, slow, slower, veryslow, and placebo. Each value specifies a level of trade-off between encoding speed and video quality. For example, the ultrafast preset has the fastest encoding speed but the lowest video quality, while the placebo preset sacrifices the encoding speed for the best video quality.	{"profile": "high", "preset": "veryfast"}
Layout	object	The video layout information. Note The video layout information includes the x-coordinate, y-coordinate, width, height, and layer of the pane. For audio-only transcoding, no video layout information is returned.
UserPanes	array<object>	The information about the panes.
	array<object>
UserInfo	object	The information about the user whose stream is played in the pane.
SourceType	string	The source of the video. This parameter is valid only if you set StreamType to 2. Valid values: camera (default): captures the video by using a camera. shareScreen: captures the content displayed on a screen.	camera
ChannelId	string	The ID of the channel where the user is.	yourChannelId
UserId	string	The ID of the user.	yourSubUserId
Height	string	The height of the pane. The value is normalized.	0.2632
Width	string	The width of the pane. The value is normalized.	0.3564
X	string	The x-coordinate of the pane. The value is normalized.	0.2456
Y	string	The y-coordinate of the pane. The value is normalized.	0.3789
ZOrder	string	The layer of the pane. A value of 0 indicates that the pane is placed at the bottom layer. A larger value indicates a higher layer.	0
BackgroundImageUrl	string	The URL of the background image of the pane. This image is displayed if the user turns off the camera or is not present in the channel.	yourImageUrl
RenderMode	string	The display mode. Valid values: 0: proportionally scales the video or background image to fit the pane. Black bars are added to fill the extra space. 1 (default): crops the video or background image to fit the pane.	1
UserInfos	array<object>	The information about the user whose stream is mixed. If an empty value is returned, streams from all users are mixed.
	object
ChannelId	string	The ID of the channel where the user is.	yourChannelId
UserId	string	The ID of the user.	yourSubUserId
SourceType	string	The source of the video. This parameter is valid only if you set StreamType to 2. Valid values: camera (default): captures the video by using a camera. shareScreen: captures the content displayed on a screen.	camera
StreamType	string	The type of the stream that is relayed. Valid values: 0 (default): the original stream. 1: the audio-only stream. 2: the video-only stream.	0
SeiParams	object	The supplemental enhancement information (SEI) parameters.
LayoutVolume	object	The layout and volume SEI. If the return value is an empty string, the default layout and volume SEI is used.
FollowIdr	string	Indicates whether to add SEI messages to Instantaneous Decoder Refresh (IDR) frames. Valid values: 0: does not add SEI messages. 1: adds SEI messages.	0
Interval	string	The interval at which the SEI messages are added. Unit: milliseconds.	1000
PassThrough	object	The custom SEI.
FollowIdr	string	Indicates whether to add SEI messages to Instantaneous Decoder Refresh (IDR) frames. Valid values: 0: does not add SEI messages. 1: adds SEI messages.	0
Interval	string	The interval at which the SEI messages are added. Unit: milliseconds.	1000
PayloadContent	string	The payload content of the custom SEI.	yourPayloadContent
PayloadContentKey	string	The key of the payload content. Default value: udd.	yourPayloadContentKey
PayloadType	string	The custom payload type. Valid values: 100 to 254. Default value: 5.	100

Examples

Success response

JSON format

{
  "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"
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	%s.	Parameter verification failed
400	InvalidAppId	%s, please check and try again later.	AppId is invalid, please check and try again.
400	MissingParam	%s, please check and try again later.	Parameter is missing, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
403	OperationDenied	Your account has not enabled the Live service
403	Forbidden	%s, please check and try again later.	No permission, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.