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

调试

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

请求参数

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

系统规定参数，取值：DescribeCasterComponents。

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

导播台ID。
ComponentId String 否 21926b36-7dd2-4fde-ae25-51b5bc8e****

组件ID。

返回数据

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

请求ID。
Components Array of Component

组件列表。
Component
ComponentId String 72d2ec7a-4cd7-4a01-974b-7cd53947****

组件ID。
ComponentLayer Struct

组件Layer的尺寸，布局等信息。
HeightNormalized Float 0.5

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

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

WidthNormalized Float 0.5

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

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

元素的位置参考坐标值。取值：

  • topLeft（默认值）：左上。
  • topRight：右上。
  • bottomLeft：左下。
  • bottomRight：右下。
PositionNormalizeds List 0,0.3

Layer 元素的位置归一化值[x,y], 默认为[0,0]。

说明 x，y需要进行归一化计算。
Transparency Integer 200

该Layer的透明度，取值范围为0~255。

0代表完全透明。255（默认）代表完全不透明。

ComponentName String component_name

组件名称，默认为组件ID。
ImageLayerContent Struct

Image元素属性。
MaterialId String 6cf724c6ebfd4a59b5b3cec6f10d****

媒资库素材ID。
TextLayerContent Struct

Text元素属性。
Text String hello world

文本内容。
Color String 0xff0000

文字色彩。取值范围为0x000000~0xffffff。

FontName String KaiTi

字体名字取系统预设值。取值：

  • KaiTi：楷体。
  • AlibabaPuHuiTi-Regular：阿里巴巴普惠体-常规。
  • AlibabaPuHuiTi-Bold：阿里巴巴普惠体-粗体。
  • NAlibabaPuHuiTi-Light：阿里巴巴普惠体-细体。
  • NotoSansHans-Regular：思源黑体-常规。
  • NotoSansHans-Bold：思源黑体-粗体。
  • NotoSansHans-Light：思源黑体-细体。

默认为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 Struct

Caption元素属性。
BorderColor String 0x000000

文字边框色彩。

取值范围为0x000000~0xffffff。默认：””，表示无效。

BorderWidthNormalized Float 0

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

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

Color String 0x000000

文字色彩。取值范围为0x000000~0xffffff。

FontName String KaiTi

字体名字取系统预设值。取值：

  • KaiTi：楷体。
  • AlibabaPuHuiTi-Regular：阿里巴巴普惠体-常规。
  • AlibabaPuHuiTi-Bold：阿里巴巴普惠体-粗体。
  • NAlibabaPuHuiTi-Light：阿里巴巴普惠体-细体。
  • NotoSansHans-Regular：思源黑体-常规。
  • NotoSansHans-Bold：思源黑体-粗体。
  • NotoSansHans-Light：思源黑体-细体。

默认为KaiTi。

LineSpaceNormalized Float 0

行间距。表示每两行字之间的间隔。默认值为0。
LocationId String RV01

组件类型为caption时，表示引用的视频源Location（通道IChannelId）。
PtsOffset Integer 0

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

取值范围为-10000~+10000。默认值为0。

ShowSourceLan Boolean false

是否显示源语言。取值：

  • true：显示。
  • false（默认值）：不显示。
SizeNormalized Float 0.1

字体归一化大小，字体设置大小为[font_size,output_height]。

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

SourceLan String cn

视频源的原始音频语言。取值：

  • en：英文。
  • cn（默认）：中文。
  • es：西班牙文。
  • ru：俄文。
TargetLan String cn

视频源的目标音频语言。取值：

  • en：英文。
  • cn（默认）：中文。
  • es：西班牙文。
  • ru：俄文。
WordCountPerLine Integer 15

每行最大展示字数。
WordSpaceNormalized Float 0

字间距，表示每两个字之间的间隔。默认值为0。

WordsCount Integer 35

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

取值范围为10~50。默认值为35。

Total Integer 3

总记录数。

示例

请求示例

https://live.aliyuncs.com?Action=DescribeCasterComponents
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<公共请求参数>

正常返回示例

XML格式 

<DescribeCasterComponentsResponse>
	  <RequestId>3be7ade8-d907-483c-b24a-0dad4595beaf</RequestId>
	  <Components>
		    <ComponentId>72d2ec7a-4cd7-4a01-974b-7cd53947****</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://live/image/fb628e2469f94f2aa2c0c219af8b2527.jpg</url>
		    </ImageLayerContent>
	  </Components>
</DescribeCasterComponentsResponse>

JSON格式 

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

错误码

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