DescribeCasterComponents - 查询导播台组件列表 - 视频直播

调用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}`	无	无

请求参数

名称	类型	必填	描述	示例值
CasterId	string	是	导播台 ID。如果您通过 CreateCaster 接口创建导播台，请查看 CreateCaster 接口调用返回的参数 CasterId 值。如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。说明直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
ComponentId	string	否	组件 ID。如果您通过 AddCasterComponent 接口添加导播台组件，请查看 AddCasterComponent 接口调用返回的参数 ComponentId 值。	21926b36-7dd2-4fde-ae25-51b5bc8e****

返回参数

名称	类型	描述	示例值
	object
Components	array<object>	组件列表。
Component	object
CaptionLayerContent	object	Caption 元素属性。
BorderColor	string	文字边框色彩。取值范围为0x000000~0xffffff。默认：""，表示无效。	0x000000
BorderWidthNormalized	float	文字边框宽度归一化值。该归一化值是基于文字的 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	float	行间距。表示每两行字之间的间隔。默认值为 0。	0
LocationId	string	组件类型为 caption 时，表示引用的视频源 Location（通道 IChannelId）。	RV01
PtsOffset	integer	纠正当前字幕 pts 与语音 pts 偏差值。取值范围为 -10000~+10000。默认值为 0。	0
ShowSourceLan	boolean	是否显示源语言。取值： true：显示。 false（默认值）：不显示。	false
SizeNormalized	float	字体归一化大小，字体设置大小为`[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	float	字间距，表示每两个字之间的间隔。默认值为 0。	0
WordsCount	integer	显示字数，可配合字体大小调整。取值范围为10~50。默认值为 35。	35
ComponentId	string	组件 ID。	72d2ec7a-4cd7-4a01-974b-7cd53947****
ComponentLayer	object	组件 Layer 的尺寸，布局等信息。
HeightNormalized	float	Layer 元素的高度归一化比例值，其中元素的宽度会按照该高度来进行等比缩放。默认值为 0，表示按照元素的原始尺寸进行显示。	0.5
PositionNormalizeds	array	Layer 元素的位置归一化值`[x,y]`, 默认为`[0,0]`。说明 x，y 需要进行归一化计算。
Position	float	值。	0.3
PositionRefer	string	元素的位置参考坐标值。取值： topLeft（默认值）：左上。 topRight：右上。 bottomLeft：左下。 bottomRight：右下。	topLeft
Transparency	integer	该 Layer 的透明度，取值范围为 0~255。 0 代表完全透明。255（默认）代表完全不透明。	200
WidthNormalized	float	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	float	文字边框宽度归一化值是基于文字的 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	float	字体归一化大小。设置大小为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
404	InvalidCaster.NotFound	%s
500	InternalError	%s

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史