All Products
Search

This Product

    ApsaraVideo Live:UpdateLiveMPUTask

    Document Center

    ApsaraVideo Live:UpdateLiveMPUTask

    Last Updated:Jan 13, 2026

    Updates a mixed-stream relay task.

    Operation description

    Make sure that a mixed-stream relay task is created before you call this operation. You can call the StartLiveMPUTask operation to create a mixed-stream relay task.

    QPS limit

    You can call this operation up to 500 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:UpdateLiveMPUTask

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AppId

    string

    Yes

    The application ID. You can specify only one application ID. The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).

    yourAppId
    ChannelId

    string

    Yes

    The channel ID. You can specify only one channel ID. The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).

    yourChannelId
    TaskId

    string

    Yes

    The task ID. You can specify only one task ID. The ID can be up to 55 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The ID must be unique.

    yourTaskId
    MixMode

    string

    No

    The stream mixing mode. Valid values:

    • 0: the single-stream relay mode. In this mode, the service only relays the original single stream, but does not transcode mixed streams. You do not need to set parameters for mixed-stream transcoding.

    • 1 (default): the mixed-stream relay mode.

    0
    StreamURL

    string

    No

    The ingest URL. You can specify only one ingest URL in the Real-Time Messaging Protocol (RTMP) format. The URL can be up to 2,048 characters in length. For information about the generation rules of ingest URLs, see Ingest and streaming URLs.

    Note

    • If the ingest URL is under a domain name for which hotlink protection is enabled, you must include an access token in the URL.

    • You cannot use the same ingest URL in different tasks.

    • You cannot use the same ingest URL within 10 seconds after a task is stopped.

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

    array<object>

    No

    The multiple ingest URLs to relay. This parameter allows you to specify multiple ingest URLs.

    object

    No

    URL

    string

    No

    The ingest URL. Only the RTMP format is supported. The URL can be up to 2,048 characters in length. For information about the generation rules of ingest URLs, see Ingest and streaming URLs.

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

    boolean

    No

    Specifies whether to perform stream relay by using Alibaba Cloud CDN. Valid values:

    • false: performs stream relay by using a CDN service that is not Alibaba Cloud CDN.

    • true: performs stream relay by using Alibaba Cloud CDN.

    Note

    The default value of this parameter is false.

    false
    SingleSubParams

    object

    No

    The single-stream relay parameters. These parameters are required if you set MixMode to 0.

    SourceType

    string

    No

    The type of the video source. This parameter is valid only when you set StreamType to 2. Valid values:

    • camera (default)

    • shareScreen

    camera
    StreamType

    string

    No

    The type of the stream that you want to relay. Valid values:

    • 0 (default): original stream

    • 1: only the audio track

    • 2: only the video track

    0
    UserId

    string

    Yes

    The user ID. In the single-stream relay mode, you can relay only one stream in a request.

    yourSubUserId
    TranscodeParams

    object

    No

    The mixed-stream relay parameters. These parameters are required if you set MixMode to 1.

    Background

    object

    No

    The global background image.

    RenderMode

    string

    No

    The display mode of the global background image.

    • 0: scales the background image proportionally to fit the view, with black bars displayed.

    • 1 (default): crops the background image to fit the view.

    1
    URL

    string

    No

    The URL of the global background image.

    yourImageUrl
    EncodeParams

    object

    No

    The encoding parameters for the output stream.

    AudioOnly

    string

    No

    Specifies whether the output stream is an audio-only stream. Valid values:

    • true: The output stream is an audio-only stream. If you set this parameter to true, you need to configure only audio-related parameters under EncodeParams.

    • false (default): The output stream is not an audio-only stream. If you set this parameter to false, you need to configure all parameters under EncodeParams, except the VideoCodec and EnhancedParam parameters.

    false
    AudioBitrate

    string

    No

    The bitrate of the audio. Valid values: [8,500]. Unit: Kbit/s.

    128
    AudioChannels

    string

    No

    The number of sound channels. Valid values: 1 and 2.

    2
    AudioSampleRate

    string

    No

    The audio sampling rate. Valid values: 8000, 16000, 32000, 44100, and 48000. Unit: Hz.

    44100
    VideoCodec

    string

    No

    The video codec. Valid values:

    • H.264 (default)

    • H.265

    H.264
    VideoBitrate

    string

    No

    The bitrate of the video. Valid values: [1,10000]. Unit: Kbit/s.

    3500
    VideoFramerate

    string

    No

    The frame rate of the video. Valid values: [1,60]. Unit: frames per second (FPS).

    25
    VideoGop

    string

    No

    The group of pictures (GOP) size of the video. Valid values: [1,60].

    20
    VideoHeight

    string

    No

    The height of the video. Valid values: [0,1920]. Unit: pixels.

    1000
    VideoWidth

    string

    No

    The width of the video. Valid values: [0,1920]. Unit: pixels.

    1920
    EnhancedParam

    string

    No

    The parameter used for encoding enhancement, which is a JSON string. The parameter includes the optional profile and preset fields.

    • profile: the encoding level. If the video codec is H.264, the valid values of this field are baseline, main, and high. If the video codec is H.265, the valid value of this field is main.

    • preset: adjusts the trade-off between encoding speed and video quality. The valid values of this field are 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.

    Note

    A value of superfast for the preset field is suitable for real-time communication scenarios. We recommend that you not set the field if you are not a professional encoding engineer.

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

    object

    No

    The video layout information.

    Note

    If video transcoding is required, you must specify the video layout information, including the x-coordinate and y-coordinate, the width and height, and the layer. For audio-only transcoding, leave the video layout information empty.

    UserPanes

    array<object>

    No

    The information about the panes.

    array<object>

    No

    The information about the pane.

    UserInfo

    object

    No

    The information about the user whose stream is played in the pane. If you leave this parameter empty, the system automatically sets this parameter based on the order in which streamers join the channel.

    Note

    • If you specify the information about a user by using this parameter, the information about the user must also be specified by using the TranscodeParams.UserInfos parameter.

    • This parameter is valid only when you set StreamType to 0 or 2.

    SourceType

    string

    No

    The type of the video source. This parameter is valid only when you set StreamType to 2. Valid values:

    • camera (default)

    • shareScreen

    camera
    ChannelId

    string

    No

    The ID of the channel where the user is. If the user is in the same channel, you can leave this parameter empty. We recommend that you specify this parameter when you perform stream mixing across channels.

    yourChannelId
    UserId

    string

    No

    The user ID.

    yourSubUserId
    Height

    string

    No

    The height of the pane. The value is normalized.

    0.2632
    Width

    string

    No

    The width of the pane. The value is normalized.

    0.3564
    X

    string

    No

    The x-coordinate of the pane. The value is normalized.

    0.2456
    Y

    string

    No

    The y-coordinate of the pane. The value is normalized.

    0.3789
    ZOrder

    string

    No

    The layer in which the pane resides. A value of 0 indicates the bottom layer. Each increment of the value by 1 indicates the next upper layer.

    0
    BackgroundImageUrl

    string

    No

    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

    No

    The display mode of the pane. Valid values:

    • 0: scales the video proportionally to fit the view, with black bars displayed.

    • 1 (default): crops the video to fit the view.

    1
    UserInfos

    array<object>

    No

    The information about the users whose streams are subscribed to. If you leave this parameter empty, streams from all users are mixed.

    object

    No

    The information about the user.

    SourceType

    string

    No

    The type of the video source that is subscribed to. This parameter is valid only when you set StreamType to 2. Valid values:

    • camera (default)

    • shareScreen

    camera
    StreamType

    string

    No

    The type of the relayed stream that is subscribed to. Valid values:

    • 0 (default): original stream

    • 1: only the audio track

    • 2: only the video track

    0
    ChannelId

    string

    No

    The ID of the channel where the subscribed user is. If the user is in the same channel, you can leave this parameter empty. We recommend that you specify this parameter when you perform stream mixing across channels.

    yourChannelId
    UserId

    string

    Yes

    The ID of the subscribed user.

    yourSubUserId
    SeiParams

    object

    No

    The supplemental enhancement information (SEI) parameters.

    LayoutVolume

    object

    No

    The layout and volume SEI. If you leave this parameter empty, the default layout and volume SEI is used.

    FollowIdr

    string

    No

    Specifies whether to include the SEI in an Instantaneous Decoder Refresh (IDR) frame. Valid values:

    • 0: does not include the SEI.

    • 1: includes the SEI.

    0
    Interval

    string

    No

    The interval at which the SEI is sent. Valid values: [1000,5000]. Unit: milliseconds.

    1000
    PassThrough

    object

    No

    Specifies whether to pass through the SEI.

    FollowIdr

    string

    No

    Specifies whether to include the SEI in an IDR frame. Valid values:

    • 0: does not include the SEI.

    • 1: includes the SEI.

    0
    Interval

    string

    No

    The interval at which the SEI is sent. Valid values: [1000,5000]. Unit: milliseconds.

    1000
    PayloadContent

    string

    No

    The payload content of the SEI.

    yourPayloadContent
    PayloadContentKey

    string

    No

    The key of the payload content of the SEI. If you do not specify this parameter, the default value udd is used.

    yourPayloadContentKey

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

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

    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 InternalError
    403 OperationDenied Your account has not enabled the Live service
    403 Forbidden %s

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.