查询字幕模板_视频直播(LIVE)-阿里云帮助中心

使用说明

本接口支持指定分页参数查询字幕模板列表信息，调用时请保证参数设置符合要求。

重要当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。

QPS限制

本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeLiveAISubtitle	系统规定参数。取值：DescribeLiveAISubtitle。
SubtitleId	String	否	445409ec-7eaa-461d-8f29-4bec2eb9****	字幕模板ID。
SubtitleName	String	否	sub01	字幕模板名称，仅支持数字、大小写字母或短横线-，短横线不和位于首位。
PageNumber	String	否	1	分页的页数。取值范围【1,100】
PageSize	String	否	100	每页模板数值。取值范围【1,100】
IsDefault	Boolean	否	false	是否查询字幕默认模版，取值范围： true，查询。 false，不查询。说明默认模版：系统预先内置的参数集，用户可以通过AddLiveAISubtitle接口的copyFrom参数使用。

返回数据

名称	类型	示例值	描述
RequestId	String	5c6a2a0df228-4a64- af62-20e91b96****	请求ID。
SubtitleConfigs	Array of SubtitleConfig		字幕模板信息列表。
SubtitleConfig
DstLanguage	String	zh-CN	翻译目标语言
SrcLanguage	String	zh-CN	源语言
FontColor	String	0xFFFFFF	字体颜色
FontName	String	AlibabaPuHuiTi-Regular	字体
ShowSourceLan	Integer	true	是否显示源语言
MaxLines	Integer	2	显示行数
WordPerline	Integer	20	每行显示字数
PositionNormalized	Array of Float	[0.3,0.35]	字幕位置
BgColor	String	0xFF0000	字幕背景颜色
BgWidthNormalized	Float	0.09	字幕背景尺寸
BorderWidthNormalized	Float	0.05	字体粗细
Width	String	1280	预览画面宽度
Height	String	720	预览画面高度
SubtitleName	String	sub1	字幕模板名称
SubtitleId	String	597991f3-6ef9-4100-9238-82951de1****	字幕模板ID
RulesRefer	Array of String	1419783e-0dd2-4485-a298-6e4a0e4e****	字幕规则ID
FontSizeNormalized	String	0.037	字体尺寸
Description	String	live AI subtitle template	描述信息

示例

请求示例

http(s)://[live.aliyuncs.com]/?Action=DescribeLiveAISubtitle
&SubtitleId=445409ec-7eaa-461d-8f29-4bec2eb9****
&SubtitleName=sub01
&PageNumber=1
&PageSize=100
&IsDefault=false
&公共请求参数

正常返回示例

XML格式

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

<DescribeLiveAISubtitleResponse>
    <RequestId>5c6a2a0df228-4a64- af62-20e91b96****</RequestId>
    <SubtitleConfigs>
        <DstLanguage>zh-CN</DstLanguage>
        <SrcLanguage>zh-CN</SrcLanguage>
        <FontColor>0xFFFFFF</FontColor>
        <FontName>AlibabaPuHuiTi-Regular</FontName>
        <MaxLines>2</MaxLines>
        <WordPerline>20</WordPerline>
        <PositionNormalized>[0.3,0.35]</PositionNormalized>
        <BgColor>0xFF0000</BgColor>
        <BgWidthNormalized>0.09</BgWidthNormalized>
        <BorderWidthNormalized>0.05</BorderWidthNormalized>
        <Width>1280</Width>
        <Height>720</Height>
        <SubtitleName>sub1</SubtitleName>
        <SubtitleId>597991f3-6ef9-4100-9238-82951de1****</SubtitleId>
        <RulesRefer>1419783e-0dd2-4485-a298-6e4a0e4e****</RulesRefer>
        <FontSizeNormalized>0.037</FontSizeNormalized>
        <Description>live AI subtitle template</Description>
    </SubtitleConfigs>
</DescribeLiveAISubtitleResponse>

JSON格式

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

{
  "RequestId" : "5c6a2a0df228-4a64- af62-20e91b96****",
  "SubtitleConfigs" : [ {
    "DstLanguage" : "zh-CN",
    "SrcLanguage" : "zh-CN",
    "FontColor" : "0xFFFFFF",
    "FontName" : "AlibabaPuHuiTi-Regular",
    "MaxLines" : 2,
    "WordPerline" : 20,
    "PositionNormalized" : [ 0.3, 0.35 ],
    "BgColor" : "0xFF0000",
    "BgWidthNormalized" : 0.09,
    "BorderWidthNormalized" : 0.05,
    "Width" : "1280",
    "Height" : "720",
    "SubtitleName" : "sub1",
    "SubtitleId" : "597991f3-6ef9-4100-9238-82951de1****",
    "RulesRefer" : [ "1419783e-0dd2-4485-a298-6e4a0e4e****" ],
    "FontSizeNormalized" : "0.037",
    "Description" : "live AI subtitle template"
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
400	InvalidParameter	%s.	参数错误
400	MissingParameter	%s.	参数缺失

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