调用DescribeCasterComponents查询导播台组件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCasterComponents

系统规定参数,取值:DescribeCasterComponents

CasterId String a2b8e671-2fe5-4642-a2ec-bf93880e1a49

导播台ID。

ComponentId String 21926b36-7dd2-4fde-ae25-51b5bc8e52d8

组件ID。

返回数据

名称 类型 示例值 描述
RequestId String 3be7ade8-d907-483c-b24a-0dad4595beaf

请求ID。

Components

组件列表。

ComponentId String 72d2ec7a-4cd7-4a01-974b-7cd53947f053

组件Id。

ComponentLayer

组件Layer的尺寸,布局等信息。

HeightNormalized Float 0.5

设置该layer元素的高度归一化比例值,其中元素的宽度会按照该高度来进行等比缩放。

默认值为0,表示按照元素的原始尺寸进行显示。

WidthNormalized Float 0.5

设置该layer元素的宽度归一化比例值,其中元素的高度会按照该宽度来进行等比缩放。默认值为0,表示按照元素的原始尺寸进行显示。

说明 该字段和heightNormalized有冲突。一旦同时设置,只有heightNormalized生效。如果只能设置一个,后面设置的值会影响前面的设置。
PositionRefer String topLeft

设置元素的position 参考坐标值。

取值范围:topLeft(默认值)| topRight | bottomLeft | bottomRight

PositionNormalizeds 0,0.3

设置该layer 元素的位置归一化值[x,y], 默认为[0,0]

说明 x,y需要进行归一化计算。
ComponentName String component_name

组件名称,默认为组件ID。

ImageLayerContent

Image元素属性。

MaterialId String 6cf724c6ebfd4a59b5b3cec6f10d5ecf

媒资库素材ID。

TextLayerContent

Text元素属性。

Text String hello world

文本内容默认为””

Color String 0xff0000

文字色彩。取值:0x000000-0xffffff

FontName String KaiTi

字体名字取系统预设值。

默认为楷体,“KaiTi”

SizeNormalized Float 16

字体归一化大小。

设置大小为font_size/output_height。如果系统根据归一化方式反计算的出来的字体大小>1024, 取1024。默认值为-1,表示无效。

BorderWidthNormalized Float 0

文字边框宽度归一化值是基于文字的size来计算的,即BorderWidth/FontSize

如果系统归一化反计算出来的值超过16,取16。默认值为0

BorderColor String 0x000000

文字边框色彩。取值:0x000000-0xffffff。默认:””,表示无效。

LocationId String RC01

用于指定组件位置。

每个位置至多设置一个组件,格式需符合“RC01…RC12”。

ComponentType String text

组件类型。取值:text | image | caption

Effect String animateV

组件显示的特效。取值:

  • none:无
  • animateH:水平滚动
  • animateV:垂直滚动
CaptionLayerContent

Caption元素属性。

BorderColor String 0x000000

文字边框色彩。

  • 取值:0x000000-0xffffff
  • 默认:””,表示无效。
BorderWidthNormalized Float 0

文字边框宽度归一化值。该归一化值是基于文字的size来计算的,即BorderWidth、FontSize。

如果系统归一化反计算出来的值超过16,取16。默认值:0

Color String 0x000000

文字色彩。取值:0x000000-0xffffff

FontName String KaiTi

字体名字。

取系统预设值,默认楷体,“KaiTi”

LocationId String RV01

组件类型为caption时,表示引用的视频源Location(通道IChannelId)。

PtsOffset Integer 0

纠正当前字幕pts与语音pts偏差值。

  • 取值范围:-10000~+10000
  • 默认值:0
SizeNormalized Float 0.1

字体归一化大小,字体设置大小为:”font_size/output_height”。

如果系统根据归一化方式反计算的出来的字体大小大于1024,取1024。默认值:-1,表示无效。

WordsCount Integer 35

显示字数,可配合字体大小调整。

  • 取值范围:10~50
  • 默认值:35
Total Integer 3

总记录数。

示例

请求示例


https://live.aliyuncs.com?Action=DescribeCasterComponents
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e1a49
&<公共请求参数>

正常返回示例

XML 格式

<DescribeCasterComponentsResponse>
	  <RequestId>3be7ade8-d907-483c-b24a-0dad4595beaf</RequestId>
	  <Components>
		    <ComponentId>72d2ec7a-4cd7-4a01-974b-7cd53947f053</ComponentId>
		    <ComponentName>imageName</ComponentName>
		    <LocationId>RC01</LocationId>
		    <ComponentType>image</ComponentType>
		    <Effect>animateV</Effect>
		    <ComponentLayer>
			      <HeightNormalized>0.5</HeightNormalized>
			      <PositionRefer>topLeft</PositionRefer>
			      <WidthNormalized>0.5</WidthNormalized>
			      <PositionNormalized>0</PositionNormalized>
			      <PositionNormalized>0.3</PositionNormalized>
		    </ComponentLayer>
		    <ImageLayerContent>
			      <url>http://XXXXXX/XXXXXX/fb628e2469f94f2aa2c0c219af8b2527.jpg</url>
		    </ImageLayerContent>
	  </Components>
</DescribeCasterComponentsResponse>

JSON 格式

{
	"RequestId":"3be7ade8-d907-483c-b24a-0dad4595beaf",
	"Components":[
		{
			"LocationId":"RC01",
			"ComponentLayer":{
				"PositionNormalized":[
					0,
					0.3
				],
				"HeightNormalized":0.5,
				"WidthNormalized":0.5,
				"PositionRefer":"topLeft"
			},
			"ComponentType":"image",
			"Effect":"animateV",
			"ImageLayerContent":{
				"url":"http://XXXXXX/XXXXXX/fb628e2469f94f2aa2c0c219af8b2527.jpg"
			},
			"ComponentId":"72d2ec7a-4cd7-4a01-974b-7cd53947f053",
			"ComponentName":"imageName"
		}
	]
}

错误码

访问错误中心查看更多错误码。