全部產品
Search

搜尋本產品

    ApsaraVideo Live：ModifyStudioLayout - 修改虛擬演播廳布局

    文件中心

    ApsaraVideo Live：ModifyStudioLayout - 修改虛擬演播廳布局

    更新時間：Jan 13, 2026

    修改虛擬演播廳布局。

    介面說明

    調用本介面修改虛擬演播廳布局。修改布局設定時，僅需傳入要修改的參數。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:ModifyStudioLayout

    update

    *Caster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    CasterId

    string

    是

    導播台 ID。

    重要 需要提前建立好，必須是虛擬演播廳類型的導播台。

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

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

    說明

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

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    LayoutId

    string

    是

    布局 ID。如果您通過 AddStudioLayout 介面添加虛擬演播廳的布局設定，請查看 AddStudioLayout 介面調用返回的參數 LayoutId 值。

    445409ec-7eaa-461d-8f29-4bec2eb9****
    LayoutName

    string

    否

    演播廳布局名稱。

    測試布局
    CommonConfig

    string

    否

    通用布局配置。格式為 JSON 字串，請參見 CommonConfig。

    重要 當 LayoutType 取值為 common 時，本參數才必填。

    { "ChannelId":"RV01" }
    BgImageConfig

    string

    否

    背景資源配置。格式為 JSON 字串，請參見 BgImageConfig。

    重要 當 LayoutType 取值為 studio 時，本參數才必填。

    { "Id":"k12kj31****", "MaterialId":"f080575eb5f4427684fc0715159a****" }
    ScreenInputConfigList

    string

    否

    摳像輸入設定。格式為 JSON 字串，請參見 ScreenInputConfig。

    重要 當 LayoutType 取值為 studio 時，本參數才必填。

    [ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ]
    MediaInputConfigList

    string

    否

    多媒體輸入資源設定。格式為 JSON 字串，請參見 MediaInputConfig。

    重要 當 LayoutType 取值為 studio 時，本參數才有效，且為選填。

    [ { "Id":"k12kj31****", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31****", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8****", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ]
    LayerOrderConfigList

    string

    否

    圖層順序設定。格式為 JSON 字串，請參見 layerOrderConfig。 支援背景素材、多媒體素材排序，暫不支援摳像層。越排在前面，越在底層。

    [ { "Type":"media", "Id":"k12kj31****" }, { "Type":"media", "Id":"k12kj31****" } ]

    CommonConfig

    名稱類型樣本描述
    ChannelIdStringRV01視頻資源綁定的通道位置 ID。

    BgImageConfig

    說明

    其中 ImageUrl 和 MaterialId 僅能輸入一個。 | 名稱 | 類型 | 樣本 | 描述 | | --------------- | ------ | --------------------- | -------------------------- | | Id | String | k12kj31**** | 該背景素材唯一 ID。 | | ImageUrl | String | http://aliyundoc.com | 素材地址 URL。 | | MaterialId | String | f080575eb5f4427684fc0715159a**** | 點播素材 ID。 |

    ScreenInputConfig

    名稱類型樣本描述
    IndexInteger1摳像源編號。前端展示使用，無邏輯作用，要求取正整數（>0）。
    ChannelIdStringRV01視頻資源綁定的通道位置 ID。
    ColorStringgreen摳像色域。取值：
    blue：藍幕背景。
    green：綠幕背景。
    auto：自動識別。
    complex：實景摳像。



    PositionXFloat0.1位置參數，座標 x。取值：[0,1]。
    素材位置以左上方為基準點。
    PositionYFloat0.2位置參數，座標 y。取值：[0,1]。
    素材位置以左上方為基準點。
    HeightNormalizedFloat0.4高度歸一化值。即摳出的人像與背景的高度比。取值：[0,1]。

    MediaInputConfig

    • 當多媒體素材是視頻源，ChannelId。

    • 當多媒體素材是圖片，傳入 ImageMeterialId。

    • ChannelId 和 ImageMeterialId 是互斥的，兩者選填一項。

    名稱類型樣本描述
    IdStringk12kj31****該多媒體素材唯一 ID。
    IndexInteger1多媒體素材編號。前端展示使用，無邏輯作用，要求取正整數（>0）。
    ChannelIdStringRV01視頻資源綁定的通道位置 ID。
    ImageMaterialIdStringlkajsdfsa8fd89asd8****點播圖片素材 ID。
    FillModeStringnone填滿類型。填 none 即可。
    PositionReferStringtopLeft素材的位置參考座標值。填 topLeft 即可，表示位置設定以左上方為基準點。
    WidthNormalizedFloat0.4素材的寬度歸一化值。即素材與背景的寬度比。取值：[0,1]。
    HeightNormalizedFloat0.4素材的高度歸一化值。即素材與背景的高度比。取值：[0,1]。
    PositionNormalizedFloat[0.1, 0.2]素材的填充區位置歸一化值[x,y]。x、y 的取值範圍分別為[0,1]。
    例如[0.1,0.2] 代表左上方水平位移 10%，垂直位移 20%。

    layerOrderConfig

    名稱類型樣本描述
    IdStringk12kj31****該資源的唯一 ID。
    TypeStringmedia資源配置的類型。
    background：背景素材。
    media：多媒體素材。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    5c6a2a0d-f228-4a64-af62-20e91b9676b3

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 MissingParameter %s. 參數缺失
    400 InvalidParameter.Malformed There are invalid parameters: %s. 存在無效參數：%s。
    400 InvalidCasterId.Malformed %s, please check and try again later. 參數CasterId無效，請檢查後重試。
    400 InvalidUserId.Malformed %s, please check userId. 傳入的userId無效，請檢查。
    400 InvalidPositionNormalized.Malformed %s, please check and try again later. 參數PositionNormalized無效，請檢查後重試。
    400 InvalidHeightOrWidthNormalized %s, please check and try again later. HeightNormalized或者WidthNormalized參數無效，請檢查後重試。
    401 IllegalOperation %s, please check and try again later. 不允許的操作，請檢查後重試。
    500 InternalError %s, please try again later. 內部錯誤，請稍後重試。
    404 InvalidLayout.NotFound %s, please check and try again later. LayoutId不存在，請檢查後重試。
    404 InvalidCaster.NotFound %s, please check and try again later. 導播台不存在，請檢查後重試。

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

    變更歷史

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