調(diào)用AddCasterComponent添加導(dǎo)播臺(tái)組件。

使用說(shuō)明

請(qǐng)先創(chuàng)建導(dǎo)播臺(tái)、了解導(dǎo)播臺(tái)的布局列表后再調(diào)用本接口添加導(dǎo)播臺(tái)組件。本接口目前支持添加圖片、文字、字幕三類組件。使用API創(chuàng)建導(dǎo)播臺(tái)，請(qǐng)參見(jiàn)創(chuàng)建導(dǎo)播臺(tái)。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過(guò)限制，API調(diào)用會(huì)被限流，這可能會(huì)影響您的業(yè)務(wù)，請(qǐng)合理調(diào)用。更多信息，請(qǐng)參見(jiàn)QPS限制。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 AddCasterComponent

系統(tǒng)規(guī)定參數(shù)。取值：AddCasterComponent。

CasterId String 是 LIVEPRODUCER_POST-cn-0pp1czt****

導(dǎo)播臺(tái)ID。

  • 如果您通過(guò)CreateCaster接口創(chuàng)建導(dǎo)播臺(tái)，請(qǐng)查看CreateCaster接口調(diào)用返回的參數(shù)CasterId值。
  • 如果您通過(guò)直播控制臺(tái)創(chuàng)建導(dǎo)播臺(tái)，請(qǐng)通過(guò)直播控制臺(tái) > 導(dǎo)播臺(tái) > 云導(dǎo)播臺(tái)頁(yè)面查看。
說(shuō)明 直播控制臺(tái)云導(dǎo)播臺(tái)頁(yè)面導(dǎo)播臺(tái)列表中的導(dǎo)播臺(tái)名稱即導(dǎo)播臺(tái)ID。
ComponentName String 否 text01

組件名稱。默認(rèn)為組件ID。
LocationId String 是 RC01

用于指定組件位置，每個(gè)位置至多設(shè)置一個(gè)組件，格式需符合“RC01~RC99”。

說(shuō)明 組件類型為caption時(shí)，表示引用的視頻源Location。
ComponentType String 是 text

組件類型。取值：

  • text：文字組件。如果選擇text類型，必須同時(shí)設(shè)置請(qǐng)求參數(shù)TextLayerContent。
  • image：圖片組件。如果選擇image類型，必須同時(shí)設(shè)置請(qǐng)求參數(shù)ImageLayerContent。
  • caption：翻譯字幕組件。如果選擇caption類型，必須同時(shí)設(shè)置請(qǐng)求參數(shù)CaptionLayerContent。
Effect String 否 animateH

組件顯示的特效 。取值：

  • none（默認(rèn)值）：無(wú)。
  • animateH：水平滾動(dòng)。
  • animateV：垂直滾動(dòng)。
ComponentLayer String 是 {"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}

該組件Layer的尺寸，布局等信息。設(shè)置元素說(shuō)明如下：

  • HeightNormalized：高度歸一化比例值。
  • WidthNormalized：寬度歸一化比例值。
  • PositionNormalized：layer 元素的位置歸一化值。
  • PositionRefer：元素的位置參考坐標(biāo)值。

JSON格式字符串，參數(shù)名采用首字母大寫(xiě)、駝峰格式。
LayerOrder String 否 cover

組件層疊次序。

  • cover：覆蓋。
  • background：背景。
TextLayerContent String 否 {"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}

Layer元素屬性。元素屬性說(shuō)明如下：

注意 當(dāng)ComponentType為text時(shí)，本參數(shù)才可用且必傳。
  • SizeNormalized：字體歸一化大小，字體設(shè)置大小為“font_size/output_height”，取值范圍[0,1]，如果系統(tǒng)根據(jù)歸一化方式反計(jì)算出來(lái)的字體大小大于1024，取1024。
  • BorderWidthNormalized：文字邊框?qū)挾葰w一化值，該歸一化值是基于文字的size來(lái)計(jì)算的，即“BorderWidth/FontSize”，取值范圍[0,1]，如果根據(jù)歸一化方式反計(jì)算出來(lái)的值超過(guò)16，取16，默認(rèn)0。
  • FontName：字體名稱，取值請(qǐng)參見(jiàn)導(dǎo)播臺(tái)字體說(shuō)明，默認(rèn)楷體，“KaiTi”。
  • BorderColor：文字邊框色彩，取值“0x000000-0xffffff”，默認(rèn)“”，表示無(wú)效。
  • Text：文本內(nèi)容，默認(rèn)“”。
  • Color：文字色彩，默認(rèn)“0xff0000”，紅色。

JSON格式字符串，參數(shù)名采用首字母大寫(xiě)，駝峰格式。
ImageLayerContent String 否 {"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"}

Layer元素屬性。元素屬性說(shuō)明如下：

注意 ComponentType為image時(shí)，該參數(shù)必傳。

MaterialId：媒資庫(kù)素材ID。上傳素材時(shí)設(shè)置的名稱就是媒資庫(kù)素材ID。

JSON格式字符串，參數(shù)名采用首字母大寫(xiě)，駝峰格式。
CaptionLayerContent String 否 {"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}

Layer元素屬性。元素屬性說(shuō)明如下：

注意 當(dāng)ComponentType為caption時(shí)，該參數(shù)必傳。
  • SizeNormalized：字體歸一化大小，字體設(shè)置大小為“font_size/output_height”，取值范圍[0,1]，精確到小數(shù)點(diǎn)后兩位，如果系統(tǒng)根據(jù)歸一化方式反計(jì)算出來(lái)的字體大小大于1024，取1024。
  • BorderWidthNormalized：文字邊框?qū)挾葰w一化值，該歸一化值是基于文字的size來(lái)計(jì)算的，即“BorderWidth/FontSize”，取值范圍[0,1]，精確到小數(shù)點(diǎn)后兩位，如果根據(jù)歸一化方式反計(jì)算出來(lái)的值超過(guò)16，取16，默認(rèn)0。
  • FontName：字體名稱，取值請(qǐng)參見(jiàn)云導(dǎo)播字體說(shuō)明，默認(rèn)楷體，“KaiTi”。
  • BorderColor：文字邊框色彩，取值“0x000000-0xffffff”，默認(rèn)“”，表示無(wú)效。
  • LocationId: 翻譯源的channelId。
  • SourceLan: 視頻源的原始音頻語(yǔ)言。En-英文，cn-中文，es-西班牙文，ru-俄文，默認(rèn)為cn-中文。
  • TargetLan：視頻源的目標(biāo)音頻語(yǔ)言。不設(shè)置表示語(yǔ)音識(shí)別，設(shè)置表示翻譯。取值：en-英文，cn-中文，es-西班牙文，ru-俄文，cn-中文。
  • ShowSourceLan：是否顯示源語(yǔ)言。取值：true-顯示，false-不顯示，默認(rèn)為false。
  • Truncation：字幕是否可以被截?cái)唷Ｈ≈担簍rue-可以被截?cái)啵琭alse-不可以被截?cái)啵J(rèn)為false。
  • SourceLanPerLineWordCount：源語(yǔ)言每行字?jǐn)?shù)，默認(rèn)20。
  • TargetLanPerLineWordCount：目標(biāo)語(yǔ)言每行字?jǐn)?shù)，默認(rèn)20。
  • SourceLanReservePages：源語(yǔ)言保留行數(shù)，Truncation為true的時(shí)候生效，默認(rèn)2行。
  • TargetLanReservePages：目標(biāo)語(yǔ)言保留行數(shù)，Truncation為true的時(shí)候生效，默認(rèn)2行。

JSON格式字符串，參數(shù)名采用首字母大寫(xiě)，駝峰格式。
HtmlLayerContent String 否 {"htmlUrl":http://caster.example.com}

H5組件配置。

云導(dǎo)播字體說(shuō)明

字體

FontName取值

楷體

KaiTi

阿里巴巴普惠體-常規(guī)

AlibabaPuHuiTi-Regular

阿里巴巴普惠體-粗體

AlibabaPuHuiTi-Bold

阿里巴巴普惠體-細(xì)體

AlibabaPuHuiTi-Light

思源黑體-常規(guī)

NotoSansHans-Regular

思源黑體-粗體

NotoSansHans-Bold

思源黑體-細(xì)體

NotoSansHans-Light

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
ComponentId String 21926b36-7dd2-4fde-ae25-51b5bc8e****

組件ID。可作為查詢導(dǎo)播臺(tái)組件、修改導(dǎo)播臺(tái)組件、刪除導(dǎo)播臺(tái)組件的請(qǐng)求參數(shù)。
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

請(qǐng)求ID。

示例

請(qǐng)求示例

http(s)://live.aliyuncs.com/?Action=AddCasterComponent
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&ComponentLayer={"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}
&ComponentType=text
&TextLayerContent={"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}&LocationId=RC01
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<AddCasterComponentResponse>
	<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
	<ComponentId>21926b36-7dd2-4fde-ae25-51b5bc8e****</ComponentId>
</AddCasterComponentResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

錯(cuò)誤碼

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。