全部產品
Search

搜尋本產品

    ApsaraVideo Live：ModifyCasterLayout - 修改導播檯布局

    文件中心

    ApsaraVideo Live：ModifyCasterLayout - 修改導播檯布局

    更新時間：Dec 29, 2025

    修改布局配置，傳遞修改項，非修改內容無需傳遞。

    介面說明

    先通過 CreateCaster 介面建立導播台，再調用本介面修改布局配置，傳遞修改項，非修改內容無需傳遞。本介面目前支援的元素填充方式為預設和自適應。

    QPS 限制

    本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:ModifyCasterLayout

    update

    *Caster

    acs:live:*:{#accountId}:caster/{#CasterId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    VideoLayer

    array<object>

    是

    視頻資訊。

    object

    否

    視頻資訊。

    FillMode

    string

    否

    元素填充方式。

    • none（預設）：不填充，以畫面作為配置目標進行 Layer 設定。

    • fit：自適應，以填充區（框）作為配置目標進行 Layer 設定，此時畫面會按照原始的寬高比縮放，長邊對齊的自適應方式在填充區（框）內置中填充，若填充區寬高比和畫面不一致，則短邊兩側無填充（顯示為下層 Layer 畫面，若下層未配置 Layer，預設為底圖黑色）。

    fit
    FixedDelayDuration

    integer

    否

    該欄位對視頻進行固定延遲設定，可用於字幕同步。 單位：毫秒。預設值：0，取值範圍：0~5000。

    5000
    HeightNormalized

    number

    否

    layer 元素的高度歸一化比例值。

    • 若採用不填充模式，元素的寬度會按照該高度來進行等比縮放，預設為 0，表示按照畫面的原始大小進行顯示。

    • 若採用自適應方式時，該欄位必傳且大於 0，表示填充區（框）高度歸一化比例值。

    1
    PositionNormalized

    array

    否

    layer 元素的位置歸一化值[x,y]。預設值為[0,0]。

    說明

    注意 x,y 需要進行歸一化計算。

    0.3

    number

    否

    layer 元素的位置歸一化值[x,y]。預設值為[0,0]。

    說明

    注意 x,y 需要進行歸一化計算。

    [0,3]
    PositionRefer

    string

    否

    元素的 position 參考座標值。取值：

    • topLeft（預設值）：左上。

    • topRight：右上。

    • bottomLeft：左下。

    • bottomRight：右下。

    • center：中間。

    • topCenter：中上。

    • bottomCenter：中下。

    • leftCenter：左中。

    • rightCenter：右中。

    topLeft
    WidthNormalized

    number

    否

    layer 元素的寬度歸一化比例值。

    • 若採用不填充模式，元素的高度會按照該寬度來進行等比縮放，預設值為 0，表示按照畫面的原始大小進行顯示。

    • 若採用自適應方式時，該欄位必傳且大於 0，表示填充區（框）寬度歸一化比例值。

    1
    AudioLayer

    array<object>

    是

    音頻資訊。

    object

    否

    音頻資訊。

    FixedDelayDuration

    integer

    否

    該欄位對音頻進行固定延遲設定，可用於字幕同步。 單位：毫秒。預設值：0。取值範圍：0~5000。

    5000
    ValidChannel

    string

    否

    確定哪些聲道可以作為音量輸入。取值：

    • leftChannel：左聲道。

    • rightChannel：右聲道。

    • all（預設值）：雙聲道。

    all
    VolumeRate

    number

    否

    layer 元素的高度歸一化比例值，其中元素的寬度會按照該高度來進行等比縮放。

    預設值為 0，表示按照元素的原始大小進行顯示。

    1
    BlendList

    array

    是

    元素為視頻資源的位置 ID，即 LocationId。

    LocationId 參見添加視頻源，與 VideoLayers 元素順序對應。

    RV02

    string

    否

    元素為視頻資源的位置 ID，即 LocationId。

    LocationId 參見添加視頻源，與 VideoLayers 元素順序對應。

    RV02
    MixList

    array

    是

    元素為音頻資源的位置 ID，即 LocationId。

    LocationId 參見添加視頻源，與 AudioLayers 元素順序對應。

    RV02

    string

    否

    元素為音頻資源的位置 ID，即 LocationId。

    LocationId 參見添加視頻源，與 AudioLayers 元素順序對應。

    RV02
    CasterId

    string

    是

    導播台 ID。

    • 如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。

    • 如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台頁面查看。

    說明

    直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。

    LIVEPRODUCER_POST-cn-0pp1czt****
    LayoutId

    string

    是

    布局 ID。如果您通過 AddCasterLayout 介面添加導播檯布局，請查看 AddCasterLayout 介面調用返回的參數 LayoutId 值。

    21926b36-7dd2-4fde-ae25-51b5bc8e****
    說明

    請求參數中的 N 表示第幾個的意思。例如：VideoLayer.N.FillMode 表示傳入第幾個元素的填充方式。VideoLayer.1.FillMode 表示傳入第 1 個元素的填充方式，VideoLayer.2.FillMode 表示傳入第 2 個元素的填充方式。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    LayoutId

    string

    布局 ID。可作為查詢導播檯布局列表的請求參數。

    21926b36-7dd2-4fde-ae25-51b5bc8e****
    RequestId

    string

    請求 ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    樣本

    正常返回樣本

    JSON格式

    {
  "LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidCasterId.Malformed %s, please check and try again later. 參數CasterId無效，請檢查後重試。
    400 InvalidUserId.Malformed %s, please check userId. 傳入的userId無效，請檢查。
    400 InvalidLayoutId.Malformed %s, please check and try again later. LayoutId無效，請檢查後重試。
    400 InvalidParameter.Malformed There are invalid parameters: %s. 存在無效參數：%s。
    400 InvalidVideoLayersAndBlendListSize.Mismatch %s, please check and try again later. VideoLayers的大小與BlendList的大小不匹配，請檢查後重試。
    400 InvalidAudioLayersAndMixListSize.Mismatch %s, please check and try again later. AudioLayers的大小與MixList的大小不匹配，請檢查後重試。
    400 InvalidPositionNormalized.Malformed %s, please check and try again later. 參數PositionNormalized無效，請檢查後重試。
    400 InvalidBlendList.ExceedNorm %s, please check and try again later. BlendList大小超過規格，請檢查後重試。
    400 InvalidMixList.ExceedNorm %s, please check and try again later. MixList大小超過規格，請檢查後重試。
    400 InvalidHeightOrWidthNormalized %s, please check and try again later. HeightNormalized或者WidthNormalized參數無效，請檢查後重試。
    400 InvalidVideoLayersConfig %s, please check and try again later. VideoLayers的大小與BlendList的大小不匹配，請檢查後重試。
    400 InvalidAudioLayersConfig %s, please check and try again later. AudioLayers的大小與MixList的大小不匹配，請檢查後重試。
    401 IllegalOperation %s, please check and try again later. 不允許的操作，請檢查後重試。
    500 InternalError %s, please try again later. 內部錯誤，請稍後重試。
    404 InvalidCaster.NotFound %s, please check and try again later. 導播台不存在，請檢查後重試。
    404 InvalidLayout.NotFound %s, please check and try again later. LayoutId不存在，請檢查後重試。

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

    變更歷史

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