All Products
Search

This Product

    ApsaraVideo Live:UpdateLiveMPUTask

    Document Center

    ApsaraVideo Live:UpdateLiveMPUTask

    Last Updated:Nov 14, 2024

    Updates a mixed-stream relay task.

    Operation description

    Use Before calling this interface, you must have already called StartLiveMPUTask to create a mix stream relay task.

    QPS Limitation

    The per-user QPS limit for this interface is 500 times/second. Exceeding this limit will result in API calls being throttled, which may impact your business operations. Please use the API reasonably. For more information, see QPS Limitations.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:UpdateLiveMPUTaskupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AppIdstringYes

    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
    ChannelIdstringYes

    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
    TaskIdstringYes

    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
    MixModestringNo

    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
    StreamURLstringNo

    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
    MultiStreamURLarray<object>No

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

    objectNo
    URLstringNo

    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****
    SingleSubParamsobjectNo

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

    SourceTypestringNo

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

    • camera (default)
    • shareScreen
    		camera
    StreamTypestringNo

    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
    UserIdstringYes

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

    		yourSubUserId
    TranscodeParamsobjectNo

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

    BackgroundobjectNo

    The global background image.

    RenderModestringNo

    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
    URLstringNo

    The URL of the global background image.

    		yourImageUrl
    EncodeParamsobjectNo

    The encoding parameters for the output stream.

    AudioOnlystringNo

    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
    AudioBitratestringNo

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

    		128
    AudioChannelsstringNo

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

    		2
    AudioSampleRatestringNo

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

    		44100
    VideoCodecstringNo

    The video codec. Valid values:

    • H.264 (default)
    • H.265
    		H.264
    VideoBitratestringNo

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

    		3500
    VideoFrameratestringNo

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

    		25
    VideoGopstringNo

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

    		20
    VideoHeightstringNo

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

    		1000
    VideoWidthstringNo

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

    		1920
    EnhancedParamstringNo

    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"}
    LayoutobjectNo

    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.
    UserPanesarray<object>No

    The information about the panes.

    objectNo

    The information about the pane.

    UserInfoobjectNo

    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.

    SourceTypestringNo

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

    • camera (default)
    • shareScreen
    		camera
    ChannelIdstringNo

    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
    UserIdstringNo

    The user ID.

    		yourSubUserId
    HeightstringNo

    The height of the pane. The value is normalized.

    		0.2632
    WidthstringNo

    The width of the pane. The value is normalized.

    		0.3564
    XstringNo

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

    		0.2456
    YstringNo

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

    		0.3789
    ZOrderstringNo

    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
    BackgroundImageUrlstringNo

    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
    RenderModestringNo

    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
    UserInfosarray<object>No

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

    objectNo

    The information about the user.

    SourceTypestringNo

    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
    StreamTypestringNo

    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
    ChannelIdstringNo

    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
    UserIdstringYes

    The ID of the subscribed user.

    		yourSubUserId
    SeiParamsobjectNo

    The supplemental enhancement information (SEI) parameters.

    LayoutVolumeobjectNo

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

    FollowIdrstringNo

    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
    IntervalstringNo

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

    		1000
    PassThroughobjectNo

    Specifies whether to pass through the SEI.

    FollowIdrstringNo

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

    • 0: does not include the SEI.
    • 1: includes the SEI.
    		0
    IntervalstringNo

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

    		1000
    PayloadContentstringNo

    The payload content of the SEI.

    		yourPayloadContent
    PayloadContentKeystringNo

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

    		yourPayloadContentKey

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    400InvalidParam%s
    400InvalidAppId%s
    403OperationDeniedYour account has not enabled the Live service
    403Forbidden%s
    404MissingParam%s
    500InternalErrorInternalError

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-10-30The Error code has changedView Change Details
    2024-08-13The Error code has changedView Change Details
    2024-08-06The Error code has changed. The request parameters of the API has changedView Change Details
    2024-07-04The Error code has changedView Change Details
    2024-06-12The Error code has changedView Change Details
    2024-03-07The Error code has changedView Change Details
    2024-03-01The Error code has changedView Change Details
    2023-12-26The Error code has changedView Change Details