調用DescribeCasterComponents查詢導播台組件列表-ApsaraVideo for Live-阿里雲

調用DescribeCasterComponents查詢導播台組件列表。

介面說明

先通過 AddCasterComponent 介面添加導播台組件，再調用本介面查詢導播台組件列表。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeCasterComponents

get

*Caster

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
CasterId	string	是	導播台 ID。如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台頁面查看。說明直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
ComponentId	string	否	組件 ID。如果您通過 AddCasterComponent 介面添加導播台組件，請查看 AddCasterComponent 介面調用返回的參數 ComponentId 值。	21926b36-7dd2-4fde-ae25-51b5bc8e****

返回參數

名稱	類型	描述	樣本值
	object
Components	object
Component	array<object>	組件列表。
	object
CaptionLayerContent	object	Caption 元素屬性。
BorderColor	string	文字邊框色彩。取值範圍為0x000000~0xffffff。預設：""，表示無效。	0x000000
BorderWidthNormalized	number	文字邊框寬度歸一化值。該歸一化值是基於文字的 size 來計算的，即 BorderWidth/FontSize。如果系統歸一化反計算出來的值超過 16，取 16。預設值為 0。	0
Color	string	文字色彩。取值範圍為0x000000~0xffffff。	0x000000
FontName	string	字型名字取系統預設值。取值： KaiTi：楷體。 AlibabaPuHuiTi-Regular：阿里巴巴普惠體-常規。 AlibabaPuHuiTi-Bold：阿里巴巴普惠體-粗體。 NAlibabaPuHuiTi-Light：阿里巴巴普惠體-細體。 NotoSansHans-Regular：思源黑體-常規。 NotoSansHans-Bold：思源黑體-粗體。 NotoSansHans-Light：思源黑體-細體。預設為 KaiTi。	KaiTi
LineSpaceNormalized	number	行間距。表示每兩行字之間的間隔。預設值為 0。	0
LocationId	string	組件類型為 caption 時，表示引用的視頻源 Location（通道 IChannelId）。	RV01
PtsOffset	integer	糾正當前字幕 pts 與語音 pts 偏差值。取值範圍為 -10000~+10000。預設值為 0。	0
ShowSourceLan	boolean	是否顯示源語言。取值： true：顯示。 false（預設值）：不顯示。	false
SizeNormalized	number	字型歸一化大小，字型設定大小為`[font_size,output_height]`。如果系統根據歸一化方式反計算的出來的字型大小大於 1024，取 1024。預設值為 -1，表示無效。	0.1
SourceLan	string	視頻源的原始音頻語言。取值： en：英文。 cn（預設）：中文。 es：西班牙文。 ru：俄文。	cn
TargetLan	string	視頻源的目標音頻語言。取值： en：英文。 cn（預設）：中文。 es：西班牙文。 ru：俄文。	cn
WordCountPerLine	integer	每行最大展示字數。	15
WordSpaceNormalized	number	字間距，表示每兩個字之間的間隔。預設值為 0。	0
WordsCount	integer	顯示字數，可配合字型大小調整。取值範圍為10~50。預設值為 35。	35
ComponentId	string	組件 ID。	72d2ec7a-4cd7-4a01-974b-7cd53947****
ComponentLayer	object	組件 Layer 的尺寸，布局等資訊。
HeightNormalized	number	Layer 元素的高度歸一化比例值，其中元素的寬度會按照該高度來進行等比縮放。預設值為 0，表示按照元素的原始大小進行顯示。	0.5
PositionNormalizeds	object
Position	array	Layer 元素的位置歸一化值`[x,y]`, 預設為`[0,0]`。說明 x，y 需要進行歸一化計算。
	number	值。	0.3
PositionRefer	string	元素的位置參考座標值。取值： topLeft（預設值）：左上。 topRight：右上。 bottomLeft：左下。 bottomRight：右下。	topLeft
Transparency	integer	該 Layer 的透明度，取值範圍為 0~255。 0 代表完全透明。255（預設）代表完全不透明。	200
WidthNormalized	number	Layer 元素的寬度歸一化比例值，其中元素的高度會按照該寬度來進行等比縮放。預設值為 0，表示按照元素的原始大小進行顯示。說明該欄位和 heightNormalized 有衝突。一旦同時設定，只有 heightNormalized 生效。如果只能設定一個，後面設定的值會影響前面的設定。	0.5
ComponentName	string	組件名稱，預設為組件 ID。	component_name
ComponentType	string	組件類型。取值： text：文字組件。 image：映像組件。 caption：翻譯跑馬燈元件。	text
Effect	string	組件顯示的特效。取值： none：無。 animateH：水平滾動。 animateV：垂直滾動。	animateV
ImageLayerContent	object	Image 元素屬性。
MaterialId	string	媒資庫素材 ID。	6cf724c6ebfd4a59b5b3cec6f10d****
LocationId	string	用於指定組件位置。每個位置至多設定一個組件，格式需符合“RC01…RC12”。	RC01
TextLayerContent	object	Text 元素屬性。
BorderColor	string	文字邊框色彩。取值範圍為0x000000~0xffffff。預設為 ""，表示無效。	0x000000
BorderWidthNormalized	number	文字邊框寬度歸一化值是基於文字的 size 來計算的，即BorderWidth/FontSize。如果系統歸一化反計算出來的值超過 16，取 16。預設值為 0。	0
Color	string	文字色彩。取值範圍為0x000000~0xffffff。	0xff0000
FontName	string	字型名字取系統預設值。取值： KaiTi：楷體。 AlibabaPuHuiTi-Regular：阿里巴巴普惠體-常規。 AlibabaPuHuiTi-Bold：阿里巴巴普惠體-粗體。 NAlibabaPuHuiTi-Light：阿里巴巴普惠體-細體。 NotoSansHans-Regular：思源黑體-常規。 NotoSansHans-Bold：思源黑體-粗體。 NotoSansHans-Light：思源黑體-細體。預設為 KaiTi。	KaiTi
SizeNormalized	number	字型歸一化大小。設定大小為font_size/output_height。如果系統根據歸一化方式反計算的出來的字型大小大於 1024, 取 1024。預設值為 -1，表示無效。	16
Text	string	常值內容。	hello world
RequestId	string	請求 ID。	3be7ade8-d907-483c-b24a-0dad45******
Total	integer	總記錄數。	3

樣本

正常返回樣本

JSON格式

{
  "Components": {
    "Component": [
      {
        "CaptionLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0x000000",
          "FontName": "KaiTi",
          "LineSpaceNormalized": 0,
          "LocationId": "RV01",
          "PtsOffset": 0,
          "ShowSourceLan": false,
          "SizeNormalized": 0.1,
          "SourceLan": "cn",
          "TargetLan": "cn",
          "WordCountPerLine": 15,
          "WordSpaceNormalized": 0,
          "WordsCount": 35
        },
        "ComponentId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "ComponentLayer": {
          "HeightNormalized": 0.5,
          "PositionNormalizeds": {
            "Position": [
              0.3
            ]
          },
          "PositionRefer": "topLeft",
          "Transparency": 200,
          "WidthNormalized": 0.5
        },
        "ComponentName": "component_name",
        "ComponentType": "text",
        "Effect": "animateV",
        "ImageLayerContent": {
          "MaterialId": "6cf724c6ebfd4a59b5b3cec6f10d****"
        },
        "LocationId": "RC01",
        "TextLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0xff0000",
          "FontName": "KaiTi",
          "SizeNormalized": 16,
          "Text": "hello world"
        }
      }
    ]
  },
  "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

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

變更歷史

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