使用DescribeStudioLayouts查詢雲導播虛擬演播廳布局-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

擷取虛擬演播廳布局設定。

介面說明

先通過 AddStudioLayout 介面添加虛擬演播廳的布局設定，再調用本介面擷取虛擬演播廳布局設定。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeStudioLayouts

get

*Caster

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
CasterId	string	是	導播台 ID。如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台頁面查看。說明直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。	5c6a2a0d-f228-4a64-af62-20e91b96****
LayoutId	string	否	布局 ID。多個布局 ID 用英文逗號（,）隔開，不填則返回該導播台下所有布局。如果您通過 AddStudioLayout 介面添加虛擬演播廳的布局設定，請查看 AddStudioLayout 介面調用返回的參數 LayoutId 值。	445409ec-7eaa-461d-8f29-4bec2eb9****

返回參數

名稱	類型	描述	樣本值
	object	布局資訊。
RequestId	string	請求 ID。	5c6a2a0d-f228-4a64-af62-20e91b9676b3
StudioLayouts	array<object>	布局資訊。
	array<object>	布局資訊。
BgImageConfig	object	背景資源配置。
Id	string	該背景素材唯一 ID。	k12kj31****
ImageUrl	string	素材地址 URL。	http://example.org
LocationId	string	位置 id	RV01
MaterialId	string	點播素材 ID。	asdfas9df89asd8f9****
CommonConfig	object	通用布局資訊。此布局為通用布局時，返回此欄位。
ChannelId	string	視頻資源綁定的通道位置 ID。	RV01
VideoResourceId	string	視頻資源 ID。	asdfasdfasdfasdfa****
LayerOrderConfigList	array<object>	圖層順序配置。
	object	圖層順序配置。
Id	string	該資源的唯一 ID。	k12kj31****
Type	string	資源配置的類型。取值： background：背景素材。 media：多媒體素材。	media
LayoutId	string	演播廳布局 ID。	445409ec-7eaa-461d-8f29-4bec2eb9****
LayoutName	string	演播廳布局名稱。	Test layout
LayoutType	string	演播廳布局類型。取值： common：通用布局。 studio：演播廳布局。	studio
MediaInputConfigList	array<object>	多媒體輸入資源配置。
	object	多媒體輸入源配置。
ChannelId	string	視頻資源綁定的通道位置 ID。	RV01
FillMode	string	填滿類型。預設為 none。	none
HeightNormalized	number	素材的高度歸一化值。即素材與背景的高度比。取值：0~1。	0.4
Id	string	該多媒體素材唯一 ID。	k12kj31****
ImageMaterialId	string	點播圖片素材 ID。	lkajsdfsa8fd89asd8****
Index	integer	多媒體素材編號。前端展示使用，無邏輯作用。	1
PositionNormalized	array	素材的填充區位置歸一化值[unk][x,y][unk]。x、y 的取值範圍分別為0~1。例如[unk][0.1,0.2][unk]代表左上方水平位移 10%，垂直位移 20%。
	number	素材的填充區位置歸一化值`[x,y]`。x、y 的取值範圍分別為0~1。例如`[0.1,0.2]`代表左上方水平位移 10%，垂直位移 20%。	0.1
PositionRefer	string	素材的位置參考座標值。預設為 topLeft，表示位置設定以左上方為基準點。	topLeft
VideoResourceId	string	視頻資源 ID。	asdfasdfasdfasdfa****
WidthNormalized	number	素材的寬度歸一化值。即素材與背景的寬度比。取值：0~1。	0.4
ScreenInputConfigList	array<object>	摳像輸入配置。
	array<object>	摳像輸入配置。
AudioConfig	object	音頻配置資訊。
ValidChannel	string	對應通道。	1
VolumeRate	number	音量。	1.0
ChannelId	string	視頻資源綁定的通道位置 ID。	RV01
Color	string	摳像色域。取值： blue：藍幕背景。 green：綠幕背景。 auto：自動識別。 complex：實景摳像。	green
HeightNormalized	number	高度歸一化值。即摳出的人像與背景的高度比。取值：0~1。	0.4
Id	string	該摳像源素材唯一 ID。	k12kj31****
Index	integer	摳像源編號。前端展示使用，無邏輯作用。	1
OnlyAudio	boolean	僅音頻	true
PortraitType	integer	人像類型。取值： 0：半身。 1：全身。	0
PositionX	string	位置參數，座標 x。取值：0~1。素材位置以左上方為基準點。	0.1
PositionY	string	位置參數，座標 y。取值：0~1。素材位置以左上方為基準點。	0.2
VideoResourceId	string	視頻資源 ID。	asdfasdfasdfasdfa****
Total	integer	布局數量。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3",
  "StudioLayouts": [
    {
      "BgImageConfig": {
        "Id": "k12kj31****",
        "ImageUrl": " http://example.org",
        "LocationId": "RV01",
        "MaterialId": "asdfas9df89asd8f9****"
      },
      "CommonConfig": {
        "ChannelId": "RV01",
        "VideoResourceId": "asdfasdfasdfasdfa****"
      },
      "LayerOrderConfigList": [
        {
          "Id": "k12kj31****",
          "Type": "media"
        }
      ],
      "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "LayoutName": "Test layout",
      "LayoutType": "studio",
      "MediaInputConfigList": [
        {
          "ChannelId": "RV01",
          "FillMode": "none",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "ImageMaterialId": "lkajsdfsa8fd89asd8****",
          "Index": 1,
          "PositionNormalized": [
            0.1
          ],
          "PositionRefer": "topLeft",
          "VideoResourceId": "asdfasdfasdfasdfa****",
          "WidthNormalized": 0.4
        }
      ],
      "ScreenInputConfigList": [
        {
          "AudioConfig": {
            "ValidChannel": "1",
            "VolumeRate": 1
          },
          "ChannelId": "RV01",
          "Color": "green",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "Index": 1,
          "OnlyAudio": true,
          "PortraitType": 0,
          "PositionX": "0.1",
          "PositionY": "0.2",
          "VideoResourceId": "asdfasdfasdfasdfa****"
        }
      ]
    }
  ],
  "Total": 1
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidUserId.Malformed	%s, please check userId.	傳入的userId無效，請檢查。
400	InvalidCasterId.Malformed	%s, please check and try again later.	參數CasterId無效，請檢查後重試。
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.	導播台不存在，請檢查後重試。

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

變更歷史

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