查询字幕配置列表--视频直播-火山引擎

文档中心

立即注册

导航

查询字幕配置列表

最近更新时间：2024.08.02 16:55:42首次发布时间：2024.07.08 11:21:11

调用 ListVhostSubtitleTranscodePreset 接口，查询指定域名空下所有字幕配置列表。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=ListVhostSubtitleTranscodePreset&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVhostSubtitleTranscodePreset`	接口名称。当前 API 的名称为 `ListVhostSubtitleTranscodePreset`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名所属的域名空间。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
PresetList	Array of PresetList	`-`	字幕配置列表。

PresetList

参数	类型	示例值	描述
Vhost	String	`push.example.com`	域名空间。
App	String	`live`	应用名称。
Suffixes	Array of String	`["hd","bd"]`	转码后缀标识。
TranscodePreset	Object of TranscodePreset	`-`	字幕配置详细参数。

TranscodePreset

参数	类型	示例值	描述
PresetName	String	`igxxjdqjks`	字幕配置的名称。
Description	String	`subtitleconfig001`	字幕配置的描述信息。
DisplayPreset	String	`small`	预设配置，使用预设配置是系统将自动对字体大小、字幕行数、每行最大字符数和边距参数（MarginVertical 和 MarginHorizontal）进行智能化适配。默认为空，表示不使用预设配置，支持的预设配置如下所示。 `small` ：小字幕。 `medium`：中字幕。 `large`：大字幕。说明使用预设配置时，字幕行数、每行最大字符数、左右边距和底部边距参数不生效，系统将使用预设配置自动进行计算。
MaxRowNumber	Integer	`0`	字幕展示的行数，同时适用于原文字幕和译文字幕，支持的取值及含义如下所示。 `0`：（默认值）根据字幕字数自动进行分行展示； `1`：每种字幕展示一行； `2`：每种字幕展示两行。说明使用预设配置时，字幕行数为自动分行展示。超出行内字数限制时表示字幕将超过显示范围，此时字幕内容将被截断。
MaxCharNumber	Integer	`36`	设置在 16:9 分辨率场景下，每行字幕展示的最大字符数。说明使用预设配置时，字幕每行最大字符数设置不生效。不使用预设配置时，字幕每行最大字符数必填。每个文字、字母、符号或数字均为一个字符。当屏幕分辨率改变时，屏幕上显示的每行文字数量会相应调整，以适应新的分辨率，确保文字的显示效果和阅读体验。
Position	Object of Position	`-`	字幕位置设置，通过设置字幕距离画面左右边距和底部边距来指定字幕位置。说明使用预设配置时，字幕位置设置不生效。不使用预设配置时，字幕位置设置必填。
SourceLanguage	Object of SourceLanguage	`-`	原文字幕展示参数配置。
TargetLanguage	Array of TargetLanguage	`-`	译文字幕展示参数配置列表。
HotWordList	Array of String	`["视频直播","赛事直播","智能家居"]`	原文字幕识别时使用的热词词库。
GlossaryWordList	Array of String	`["Artificial Intelligence","Machine Learning","AI"]`	原文翻译成译文时使用的热词词库。

Position

参数	类型	示例值	描述
MarginHorizontal	Float	`0.13`	字幕距离画面底部的边距与画面高度的占比，使用归一化百分表示，取值范围为 [0,0.5]。
MarginVertical	Float	`0.5`	字幕距离画面两侧的边距与画面宽度的占比，使用归一化百分表示，取值范围为 [0,0.2]。

SourceLanguage

参数	类型	示例值	描述
Display	Boolean	`false`	是否展示原文字幕，取值及含义如下所示。 `true`：展示，此时将展示原文和译文双语字幕 `false`：不展示，此时将只展示译文字幕。说明原文字幕语言和译文字幕语言相同时，仅展示译文字幕。
Language	String	`zh`	原文字幕的语言，取值及含义如下所示。 `zh`：中英混合； `en`：英语； `ko`：韩语； `ja`：日语。
Font	String	`siyuanheiti`	原文字幕的字体，原文字幕字体根据原文字幕语言取值不同而不同，取值及含义如下所示。当原文字幕的语言是 `zh` 时，支持以下字体取值。 `siyuanheiti`：思源黑体； `songtixi`：宋体细； `songticu`：宋体粗； `heitifan`：黑体繁； `kaiti`：楷体。当原文字幕的语言是 `en` 时，支持以下字体取值。 `inter`：Inter； `roboto`：Roboto； `opposans`：OPPOSans； `siyuansongti`：思源宋体； `montserrat`：Montserrat。当原文字幕的语言是 `ko` 和 `ja` 时，支持 `notosans`(Noto Sans) 字体。
FontColor	String	`0xFF0000@0.5`	原文字幕的字体颜色，支持以下几种方法进行定义。支持以 0x 或 # 开头，后面跟着`十六进制颜色 RGB 值`，再跟着 `@+十六进制/百分比`来表示的透明度值，来定义字幕的字体颜色。例如，设置 RGB 值为 FF0000，透明度为 5%的颜色时，您可以传入 `0xFF0000@0x80`、`0xFF0000@0.5`、`#FF0000@0x80` 或 `#FF0000@0.5`。支持使用前端框架 FFmpeg 规定的颜色关键字，来定义字幕的字体颜色。例如，`AliceBlue` 表示 0xF0F8FF、`AntiqueWhite` 表示 0xFAEBD7、`Black` 表示 0x000000 等。说明查看详细颜色定义方法及更多颜色关键字，请参考 FFmpeg 的颜色定义语法。
Border	Object of Border	`-`	原文字幕的字体描边配置。

TargetLanguage

参数	类型	示例值	描述
Language	String	`zh`	译文字幕的语言，取值及含义如下所示。 `zh`：中英混合； `zh-Hant`：繁体中文； `en`：英语； `ko`：韩语； `ja`：日语； `ar`：阿拉伯语； `de`：德语； `es`：西班牙语； `fr`：法语； `hi`：印地语； `pt`：葡萄牙语； `ru`：俄语； `vi`：越南语； `th`：泰语。
Font	String	`siyuanheiti`	译文字幕的字体，译文字幕字体根据译文字幕语言取值不同而不同，取值及含义如下所示。当译文字幕的语言是 `zh` 时，支持以下字体取值。 `siyuanheiti`：思源黑体； `songtixi`：宋体细； `songticu`：宋体粗； `heitifan`：黑体繁； `kaiti`：楷体。当译文字幕的语言是 `zh-Hant` 时，支持 `siyuanheiti` （思源黑体）字体。当译文字幕的语言是 `en` 时，支持以下字体取值。 `inter`：Inter； `roboto`：Roboto； `opposans`：OPPOSans； `siyuansongti`：思源宋体； `montserrat`：Montserrat。当译文字幕的语言是 `ko`、`ja`、`ar`、`de`、`es`、`fr`、`hi`、`pt`、 `ru`、 `vi`、 `th` 时，支持 `notosans`(Noto Sans) 字体。
FontColor	String	`#FFFFFF@0xff`	译文字幕的字体颜色，支持以下几种方法进行定义。支持以 0x 或 # 开头，后面跟着`十六进制颜色 RGB 值`，再跟着 `@+十六进制/百分比`来表示的透明度值，来定义字幕的字体颜色。例如，设置 RGB 值为 FF0000，透明度为 5%的颜色时，您可以传入 `0xFF0000@0x80`、`0xFF0000@0.5`、`#FF0000@0x80` 或 `#FF0000@0.5`。支持使用前端框架 FFmpeg 规定的颜色关键字，来定义字幕的字体颜色。例如，`AliceBlue` 表示 0xF0F8FF、`AntiqueWhite` 表示 0xFAEBD7、`Black` 表示 0x000000 等。说明查看详细颜色定义方法及更多颜色关键字，请参考 FFmpeg 的颜色定义语法。
Border	Object of Border	`-`	译文字幕的字体描边配置。

Border

参数类型示例值描述

Width Integer 2 描边的宽度，单位为 px。

参数	类型	示例值	描述
Width	Integer	`2`	描边的宽度，单位为 px。
Color	String	`White`	描边的颜色，支持以下几种方法进行定义。支持以 0x 或 # 开头，后面跟着`十六进制颜色 RGB 值`，再跟着 `@+十六进制/百分比`来表示的透明度值，来定义字幕的字体颜色。例如，设置 RGB 值为 FF0000，透明度为 5%的颜色时，您可以传入 `0xFF0000@0x80`、`0xFF0000@0.5`、`#FF0000@0x80` 或 `#FF0000@0.5`。支持使用前端框架 FFmpeg 规定的颜色关键字，来定义字幕的字体颜色。例如，`AliceBlue` 表示 0xF0F8FF、`AntiqueWhite` 表示 0xFAEBD7、`Black` 表示 0x000000 等。说明查看详细颜色定义方法及更多颜色关键字，请参考 FFmpeg 的颜色定义语法。

Color

String

White

描边的颜色，支持以下几种方法进行定义。

支持以 0x 或 # 开头，后面跟着十六进制颜色 RGB 值，再跟着 @+十六进制/百分比来表示的透明度值，来定义字幕的字体颜色。例如，设置 RGB 值为 FF0000，透明度为 5%的颜色时，您可以传入 0xFF0000@0x80、0xFF0000@0.5、#FF0000@0x80 或 #FF0000@0.5。
支持使用前端框架 FFmpeg 规定的颜色关键字，来定义字幕的字体颜色。例如，AliceBlue 表示 0xF0F8FF、AntiqueWhite 表示 0xFAEBD7、Black 表示 0x000000 等。

说明

查看详细颜色定义方法及更多颜色关键字，请参考 FFmpeg 的颜色定义语法。

请求示例

POST https://live.volcengineapi.com?Action=ListVhostSubtitleTranscodePreset&Version=2023-01-01
{
    "Vhost": "push.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListVhostSubtitleTranscodePreset",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "PresetList": [
            {
                "App": "live",
                "Suffixes": [
                    "hd",
                    "bd"
                ],
                "TranscodePreset": {
                    "Description": "subtitleconfig001",
                    "DisplayPreset": "small",
                    "GlossaryWordList": [
                        "Artificial Intelligence",
                        "Machine Learning",
                        "AI"
                    ],
                    "HotWordList": [
                        "视频直播",
                        "赛事直播",
                        "智能家居"
                    ],
                    "MaxRowNumber": 0,
                    "Position": {
                        "MarginHorizontal": "0.13",
                        "MarginVertical": "0.5"
                    },
                    "PresetName": "igxxjdqjks",
                    "SourceLanguage": {
                        "Border": {
                            "Width": 2,
                            "Color": "White"
                        },
                        "Display": true,
                        "Font": "siyuanheiti",
                        "FontColor": "0xFF0000@0.5",
                        "Language": "zh"
                    },
                    "TargetLanguage": [
                        {
                            "Border": {
                                "Color": "#0C0D0E@0xff",
                                "Width": 1
                            },
                            "Font": "siyuanheiti",
                            "FontColor": "#FFFFFF@0xff",
                            "Language": "zh"
                        }
                    ]
                },
                "Vhost": "push.example.com"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
400	InvalidParam.Empty	%s is required	参数缺失，请检查错误消息中指定的参数是否传入。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.Preset	an internal error related to preset occurred, please contact the administrator.	出现与功能配置相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。