全部产品
阿里云办公

查询组件列表

更新时间:2018-06-27 19:15:48

描述

查询导播台组件列表。

请求参数

参数 类型 是否必选 描述
Action String 操作接口名,系统规定参数,取值:DescribeCasterComponents
CasterId String 导播台Id
ComponentId String 组件Id

返回参数

参数 类型 描述
RequestId String 该条任务请求Id
Components []Component 组件列表

Component

参数 类型 描述
ComponentId String 组件Id
ComponentName String 组件名称,默认为组件ID
LocationId String 用于指定组件位置,每个位置至多设置一个组件,格式需符合“RC01…RC12”
ComponentType String 组件类型,只能是预设值的一种: “text”、”image”等
Effect String 组件显示的特效
none:无
animateH:水平滚动
animateV:垂直滚动
ComponentLayer ComponentLayer 组件Layer的尺寸,布局等信息
TextLayerContent TextLayerContent Text元素属性
ImageLayerContent ImageLayerContent Image元素属性
CaptionLayerContent CaptionLayerContent Caption元素属性

ComponentLayer

参数 类型 描述
HeightNormalized Float 设置该layer元素的高度归一化比例值,其中元素的宽度会按照该高度来进行等比缩放。
默认值:0,表示按照元素的原始尺寸进行显示。
WidthNormalized Float 设置该layer元素的宽度归一化比例值,其中元素的高度会按照该宽度来进行等比缩放。
默认值:0,表示按照元素的原始尺寸进行显示。
该字段和heightNormalized有冲突。
一旦同时设置了heightNormalized和widthNormalized,只有heightNormalized生效。
如果heightNormalized和widthNormalized设置只能同时设置一个,后面设置的值会影响前面的设置。
PositionNormalized Float[] 设置该layer 元素的位置归一化值[x,y]
默认为:[0,0]
注意:x,y需要进行归一化计算。
PositionRefer String 设置元素的position 参考坐标值
取值范围:”topLeft”、”topRight”、”bottomLeft”、”bottomRight”
默认值:”topLeft”。

TextLayerContent

参数 类型 描述
Text String 文本内容
默认为””。
Color String 文字色彩
取值:“0x000000-0xffffff”
FontName String 字体名字
取系统预设值,默认楷体,“KaiTi”
SizeNormalized Float 字体归一化大小
字体设置大小为:”font_size/output_height”。
如果系统根据归一化方式反计算的出来的字体大小>1024, 取1024。
默认值:-1,表示无效。
BorderWidthNormalized Float 文字边框宽度归一化值
该归一化值是基于文字的size来计算的,即BorderWidth/FontSize。
如果系统归一化反计算出来的值超过16,取16。
默认值:0。
BorderColor String 文字边框色彩。
取值:“0x000000-0xffffff”
默认:””,表示无效。

ImageLayerContent

参数 类型 描述
MaterialId String 媒资库素材Id

CaptionLayerContent

参数 类型 是否必选 描述
LocationId String 组件类型为caption时,表示引用的视频源Location
PtsOffset Integer 纠正当前字幕pts与语音pts偏差值
取值范围:[-10000, +10000]
默认值:0
WordsCount Integer 显示字数,可配合字体大小调整
取值范围:[10,50]
默认值:35
Color String 文字色彩
取值:“0x000000-0xffffff”
FontName String 字体名字
取系统预设值,默认楷体,“KaiTi”
SizeNormalized Float 字体归一化大小,字体设置大小为:”font_size/output_height”
如果系统根据归一化方式反计算的出来的字体大小>1024, 取1024。
默认值:-1,表示无效。
BorderWidthNormalized Float 文字边框宽度归一化值
该归一化值是基于文字的size来计算的,即BorderWidth/FontSize。
如果系统归一化反计算出来的值超过16,取16。
默认值:0
BorderColor String 文字边框色彩
取值:“0x000000-0xffffff”
默认:””,表示无效。

特殊错误码

错误代码 描述 Http 状态码 语义
IllegalOperation Permission Denied 401 无权访问导播台
InvalidCaster.NotFound Caster is not found. 404 指定导播台不存在
InternalError The request processing has failed due to some unknown error, exception or failure. 500 内部错误

示例

请求示例

  1. https://live.aliyuncs.com?Action=DescribeCasterModels&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e1a49&ComponentId=21926b36-7dd2-4fde-ae25-51b5bc8e52d8&<公共请求参数>

返回示例

  1. {
  2. "RequestId": "3be7ade8-d907-483c-b24a-0dad4595beaf",
  3. "Components": [
  4. {
  5. "ComponentId": "72d2ec7a-4cd7-4a01-974b-7cd53947f053",
  6. "ComponentName":"imageName",
  7. "LocationId":"RC01",
  8. "ComponentType":"image",
  9. "Effect":"animateV",
  10. "ComponentLayer":{
  11. "HeightNormalized": 0.5,
  12. "PositionRefer": "topLeft",
  13. "WidthNormalized": 0.5,
  14. "PositionNormalized": [
  15. 0,
  16. 0.3
  17. ]
  18. },
  19. "ImageLayerContent":{
  20. "url":"http://XXXXXX/XXXXXX/fb628e2469f94f2aa2c0c219af8b2527.jpg"
  21. }
  22. }
  23. ]
  24. }