調用DescribeCasterLayouts API查詢導播檯布局列表-ApsaraVideo for Live-阿里雲

查詢導播檯布局列表。

介面說明

調用本介面查詢導播檯布局列表。若未指定具體的布局 ID，則預設查詢導播台下所有布局列表。

QPS 限制

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

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeCasterLayouts

get

*Caster

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
CasterId	string	是	導播台 ID。如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台頁面查看。說明直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	否	布局 ID。如果您不提供 LayoutId 值，則返回導播台下所有布局列表。	72d2ec7a-4cd7-4a01-974b-7cd53947****

返回參數

名稱	類型	描述	樣本值
	object
Layouts	object
Layout	array<object>	布局列表。
	object	布局列表。
AudioLayers	object
AudioLayer	array<object>	Audiolayer 配置列表。
	object	audiolayer 配置列表。
FixedDelayDuration	integer	該欄位對視頻進行固定延遲設定，可用於字幕同步。單位為毫秒（ms）。預設值為 0。取值範圍為0~5000。	20
ValidChannel	string	確定哪些聲道可以作為音量輸入。取值： leftChannel：左聲道。 rightChannel：右聲道。 all（預設值）：雙聲道。	all
VolumeRate	number	Layer 元素的高度歸一化比例值，其中元素的寬度會按照該高度來進行等比縮放。說明預設值為 0，表示按照元素的原始大小進行顯示。	1
BlendList	object
LocationId	array	位置關聯列表，與 VideoLayers 順序保持一致。
	string	位置 ID。	RV01
LayoutId	string	布局 ID。	72d2ec7a-4cd7-4a01-974b-7cd53947****
MixList	object
LocationId	array	位置關聯列表，與 AudioLayers 順序保持一致。
	string	位置 ID。	RV01
VideoLayers	object
VideoLayer	array<object>	Videolayer 配置列表，採用數組預設序列。
	object	videolayer 配置列表，採用數組預設序列。
FillMode	string	元素填充方式。取值： none（預設）：不填充。以畫面作為配置目標進行 Layer 設定。 fit：自適應。以填充區（框）作為配置目標進行 Layer 設定，此時畫面會按照原始的寬高比縮放，長邊對齊的自適應方式在填充區（框）內置中填充，若填充區寬高比和畫面不一致，則短邊兩側無填充（顯示為下層 Layer 畫面，若下層未配置 Layer，預設為底圖黑色）。	fit
FixedDelayDuration	integer	該欄位對視頻進行固定延遲設定，可用於字幕同步。單位：毫秒（ms）。預設值為 0 。取值範圍為0~5000。	20
HeightNormalized	number	Layer 元素的高度歸一化比例值。若採用不填充模式，元素的寬度會按照該高度來進行等比縮放。預設值為 0，表示按照畫面的原始大小進行顯示。若採用自適應方式，該欄位必傳且大於 0，表示填充區（框）高度歸一化比例值。	0.5
PositionNormalizeds	object
Position	array	Layer 元素的位置歸一化值`[x,y]`，預設為`[0,0]`。說明注意 x,y 需要進行歸一化計算。
	number	值。	0
PositionRefer	string	設定元素的位置參考座標值。取值： topLeft（預設值）：左上。 topRight：右上。 bottomLeft：左下。 bottomRight：右下。 center：中間。 topCenter：中上。 bottomCenter：中下。 leftCenter：左中。 rightCenter：右中。	topLeft
WidthNormalized	number	Layer 元素的寬度歸一化比例值。若採用不填充模式，元素的高度會按照該寬度來進行等比縮放。預設值為 0，表示按照畫面的原始大小進行顯示。若採用自適應方式，該欄位必傳且大於 0，表示填充區（框）寬度歸一化比例值。	0.5
RequestId	string	請求 ID。	3be7ade8-d907-483c-b24a-0dad45****
Total	integer	總記錄數。	3

樣本

正常返回樣本

JSON格式

{
  "Layouts": {
    "Layout": [
      {
        "AudioLayers": {
          "AudioLayer": [
            {
              "FixedDelayDuration": 20,
              "ValidChannel": "all",
              "VolumeRate": 1
            }
          ]
        },
        "BlendList": {
          "LocationId": [
            "RV01"
          ]
        },
        "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "MixList": {
          "LocationId": [
            "RV01"
          ]
        },
        "VideoLayers": {
          "VideoLayer": [
            {
              "FillMode": "fit",
              "FixedDelayDuration": 20,
              "HeightNormalized": 0.5,
              "PositionNormalizeds": {
                "Position": [
                  0
                ]
              },
              "PositionRefer": "topLeft",
              "WidthNormalized": 0.5
            }
          ]
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45****",
  "Total": 3
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s

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

變更歷史

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