全部產品
Search

搜尋本產品

    ApsaraVideo Live：UpdateLiveMPUTask - 更新混流轉推任務（新）

    文件中心

    ApsaraVideo Live：UpdateLiveMPUTask - 更新混流轉推任務（新）

    更新時間：Dec 13, 2025

    更新混流轉推任務。

    介面說明

    調用本介面前，您必須已經調用 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

    是

    轉推使用者識別碼，一次只能轉推一路流。

    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

    否

    混流使用者識別碼。

    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

    是

    混流時訂閱的使用者識別碼。

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

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。