调用DescribeLiveAISubtitle查询字幕模板列表。
接口说明
本接口支持指定分页参数查询字幕模板列表信息，调用时请保证参数设置符合要求。
注意 当前实时字幕功能处于邀测阶段，单个用户最多可添加 300 个字幕模板。
QPS 限制
本接口的单用户 QPS 限制为 60 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:DescribeLiveAISubtitle | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SubtitleId | string | 否 | 字幕模板 ID。 | 445409ec-7eaa-461d-8f29-4bec2eb9**** |
| SubtitleName | string | 否 | 字幕模板名称，仅支持数字、大小写字母或短横线-，短横线不和位于首位。 | sub01 |
| PageNumber | string | 否 | 分页的页数。取值范围【1,100】 | 1 |
| PageSize | string | 否 | 每页模板数值。取值范围【1,100】 | 100 |
| IsDefault | boolean | 否 | 是否查询字幕默认模版，取值范围：
说明
默认模版：系统预先内置的参数集，用户可以通过 AddLiveAISubtitle 接口的 copyFrom 参数使用。
| false |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "5c6a2a0df228-4a64- af62-20e91b96****",
"SubtitleConfigs": {
"SubtitleConfig": [
{
"DstLanguage": "zh-CN",
"SrcLanguage": "zh-CN",
"FontColor": "0xFFFFFF",
"FontName": "AlibabaPuHuiTi-Regular",
"ShowSourceLan": 0,
"MaxLines": 2,
"WordPerline": 20,
"PositionNormalized": {
"Position": [
0
]
},
"BgColor": "0xFF0000",
"BgWidthNormalized": 0.09,
"BorderWidthNormalized": 0.05,
"Width": "1280",
"Height": "720",
"SubtitleName": "sub1",
"SubtitleId": "597991f3-6ef9-4100-9238-82951de1****",
"RulesRefer": {
"RulesId": [
"1419783e-0dd2-4485-a298-6e4a0e4e****"
]
},
"FontSizeNormalized": "0.037",
"Description": "live AI subtitle template"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | %s. | 参数错误 |
| 400 | MissingParameter | %s. | 参数缺失 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在无效参数：%s。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-04 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-06-11 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |