You need to enable JavaScript to run this app.
文档中心
视频直播

视频直播

复制全文
下载 pdf
声影同传和字幕配置
DescribeSubtitleTranscodePresetDetail - 查询字幕配置详情
复制全文
下载 pdf
DescribeSubtitleTranscodePresetDetail - 查询字幕配置详情

调用 DescribeSubtitleTranscodePresetDetail,查询指定字幕配置的详情。

注意事项

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

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeSubtitleTranscodePresetDetail接口名称。当前 API 的名称为 DescribeSubtitleTranscodePresetDetail
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
PresetListArray of String["igx**dqjks","iga**dqjks"]字幕配置的名称,您可以调用 ListVhostSubtitleTranscodePreset 接口,通过 PresetName 获取字幕配置名称。

返回参数

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

参数类型示例值描述
PresetDetailListArray of PresetDetailList-字幕配置详情。

PresetDetailList

参数类型示例值描述
PresetNameStringigxxjdqjks字幕配置的名称。
StatusInteger1已废弃。
DescriptionStringsubtitleconfig001字幕配置的描述信息。
SuffixNameString_subtitle字幕后缀。例如字幕流地址为 rtmp://pull.example.com/live/test_subtitle,则字幕后缀为 _subtitle

Delay

Integer

8

播出延迟时长,以保证同传声音和字幕的翻译处理完成。单位为秒。

说明

  • 如果字幕出现的时间要早于原声或画面,可适当降低播出延迟时长,让字幕与原声或画面对齐,反之亦然。
  • 该参数仅当 SIConfig 下的 Enable 取值为 true 时生效。

DisplayPreset

String

small

(不推荐使用)预设效果,用于快速配置。
传入该参数后,系统将自动对 Font(字体)、MaxRowNumber(字幕行数)、MaxCharNumber(每行最大字符数)、Position(左右边距和底部边距)进行智能化适配,且 MaxRowNumberMaxCharNumberPosition 参数不再生效。取值如下:

  • small :小字幕。
  • medium:中字幕。
  • large:大字幕。

MaxRowNumber

Integer

0

每种语言字幕最多显示的行数。取值如下:

  • 0:根据字幕总字数和每行最大字符数自动换行,确保内容完整显示。
  • 1:每种语言的字幕最多显示一行,内容可能被截断。
  • 2:每种语言的字幕最多显示两行,内容可能被截断。

说明

  • 如传入 DisplayPreset(预设效果配置),该参数取值固定为 0
  • 该参数分别应用于原文和译文。原文和译文的行数限制单独计算。

Position

Object of Position

-

字幕位置。

说明

如传入 DisplayPreset(预设效果配置),该参数配置不生效。

SIConfigObject of SIConfig-声影同传模式配置。
SourceLanguageObject of SourceLanguage-原文字幕配置。
TargetLanguageArray of TargetLanguage-译文字幕配置。

HotWordList

Array of String

["视频直播","赛事直播","智能家居"]

热词列表。
热词(如产品名、流行语)可以提升语音识别准确率,与原文语言一致。

说明

仅原文 ASR 字幕生效。

GlossaryWordList

Array of String

["字节跳动:ByteDance","视频直播:MediaLive"]

关键词列表。
您期望在翻译时保持固定译法的专有词汇,如品牌名、人名或特定术语。系统会严格按照关键词列表翻译,以确保准确性。
格式为"原文:译文",每个"原文:译文"之间用英文逗号(,)隔开。

说明

仅字幕翻译和同传声音生效。

ReplaceMap

JSON Map

{"蒂姆":"Tim","提姆":"Tim"}

易错词列表。
格式为"目标词":"替换词",每个"目标词":"替换词"之间用英文逗号(,)隔开。只要译文/原文字幕中包含您设置的目标词,系统就会自动将其替换为替换词。

CreatedAtInteger1779335505字幕配置的创建时间。Unix 时间戳,单位为秒。
UpdatedAtInteger1779435505字幕配置的更新时间。Unix 时间戳,单位为秒。
SubtitleTosConfigObject of SubtitleTosConfig-TOS 配置,用于生成字幕 SRT 文件。

Position

参数类型示例值描述

Relative

String

top

字幕在画面中的位置。取值如下:

  • top:字幕展示在画面顶部。
  • bottom:字幕展示在画面底部。

MarginVertical

Float

0.5

字幕的上下边距,即字幕距离画面顶部或底部的距离。取值为画面高度的百分比,取值范围为 (0, 0.5]

  • Relative 取值为 top 时,表示上边距。
  • Relative 取值为 bottom 时,表示下边距。
MarginHorizontalFloat0.2字幕的左右边距,即字幕距离画面左右边缘的距离。取值为画面宽度的百分比,取值范围为 (0, 0.3]

SIConfig

参数类型示例值描述

Enable

Boolean

true

是否开启声影同传模式。取值如下:

  • true:开启声影同传模式。支持生成字幕、生成同传声音替换原声,以及驱动数字人口型与同传声音同步,提供沉浸式体验。
  • false:关闭声影同传模式,开启纯字幕模式。关闭后,SIConfig 中的其他参数均不生效。

Pipe

String

mix

声影同传类型。取值如下:

  • si:字幕、同传音频与画面完全同步,支持数字人口型功能。适用于对同步性和沉浸感要求较高的会议直播等场景。
  • mix:仅字幕。
  • realtime:实时流式原文 ASR 字幕。

SpeakerRecognition

Integer

1

是否开启同传声音功能。取值如下:

  • 大于 0:开启。开启后,将使用带有音色复刻效果的翻译语音替换直播原声。
  • 等于 0:关闭。

说明

仅在 Pipe 取值为空或 si 时生效。

DigitalHumanMouthShape

Boolean

false

是否开启数字人口型功能。取值如下:

  • true:开启。开启后,说话人口型将与同传声音同步,提升直播的沉浸感。
  • false:关闭。

说明

  • 仅在 Pipe 取值为空或 si 时生效。
  • 取值为 true 时,默认开启同传声音功能。

PipeExtra

String

{"Separator":{"HandleType":1},"Amix":{"AudioEnhance":false}}

额外配置,为 JSON 格式的字符串,包含音量均衡、降噪、原声音量等信息。详见 CreateSpeechTask 接口的 Extra 参数。

说明

仅在 SpeakerRecognition 取值大于 0,即开启同传声音时生效。

SourceLanguage

参数类型示例值描述

Display

Boolean

true

是否展示原文字幕,取值如下:

  • true:展示,此时将展示原文和译文双语字幕。
  • false:不展示,此时将仅展示译文字幕。

Language

String

zh

原文字幕语言。

  • SIConfig 下的 Enable 取值为 true 使用声影同传模式时,您可调用 GetSubtitleTranscodePresetConfig 并通过 OriginalLang 参数获取原文字幕语言对应的中文名,或通过 AsrLang 获取原文 ASR 字幕语言对应的中文名。
  • SIConfig 下的 Enable 取值为 false 使用纯字幕模式时,取值如下:
    • zh:中英混合。
    • en:英语。
    • ko:韩语。
    • ja:日语。

ShowPriority

Integer

2

原文字幕的展示优先级。
取值越大,优先级越高。例如原文字幕的 ShowPriority1,译文字幕的 ShowPriority2,则译文字幕在上,原文字幕在下。

MaxCharNumber

Integer

60

原文每行字幕的最大字符数。

说明

  • 系统会综合您传入的该参数取值以及 MarginLr(左右边距)、Font(字体)、FontSize(字号)和屏幕分辨率等因素,计算出每行最终可显示的最大字符数。
  • 每个文字、字母、符号或数字均为一个字符。
  • MaxRowNumber 取值为 12 时,如果原文的字幕总字数超出显示范围,内容将会被截断。例如每行字幕的最大字符数为 10,MaxRowNumber 取值 2,则当原文字幕总字数超出 20 时,20 字后的内容会被截断。
  • 如传入 DisplayPreset(预设效果配置),该参数配置不生效。

Font

String

siyuanheiti

原文字幕字体。

  • 当 SIConfig 下的 Enable 取值为 true 使用声影同传模式时,您可调用 GetSubtitleTranscodePresetConfig 并通过 Alias 参数获取字体对应的中文名称。
  • 当 SIConfig 下的 Enable 取值为 false 使用纯字幕模式时,具体取值如下。原文字幕语言(Language 取值)不同,原文字幕字体也随之不同。
    • 当原文字幕的语言是 zh 时,支持以下字体取值。
      • siyuanheiti:思源黑体。
      • songtixi:宋体细。
      • songticu:宋体粗。
      • heitifan:黑体繁。
      • kaiti:楷体。
    • 当原文字幕的语言是 en 时,支持以下字体取值。
      • inter:Inter。
      • roboto:Roboto。
      • opposans:OPPOSans。
      • siyuansongti:思源宋体。
      • montserrat:Montserrat。
    • 当原文字幕的语言是 ko 或 ja 时,支持 notosans(Noto Sans) 字体。

FontSize

Integer

18

原文字幕字号。单位为 px。

说明

如传入 DisplayPreset(预设效果配置),该参数配置不生效。

FontColor

String

0xFF0000@0.5

原文字幕的字体颜色。
取值支持以下表示方式:

  • 以 0x 或 # 开头的十六进制 RGB 颜色值,并可通过 @ 符号附加透明度,透明度支持十六进制(如 0x80)或小数(如 0.5)两种表示方式。例如,0xFF0000@0x800xFF0000@0.5#FF0000@0x80#FF0000@0.5 表示 RGB 值为 FF0000,透明度为 50% 的颜色。
  • FFmpeg 规定的颜色关键字,并可通过 @ 符号附加透明度,透明度支持用小数(如 0.5)表示。例如,AliceBlue@0.5 表示 RGB 值为 0xF0F8FF,透明度为 50% 的颜色。

说明

BorderObject of Border-原文字幕字体阴影。
BoxObject of Box-原文字幕字体背景。

TargetLanguage

参数类型示例值描述

Language

String

en

译文字幕语言。

  • 当 SIConfig 下的 Enable 取值为 true 使用声影同传模式时,您可调用 GetSubtitleTranscodePresetConfig 并通过 Lang 参数获取语言对应的中文名。
  • 当 SIConfig 下的 Enable 取值为 false 使用纯字幕模式时,取值如下:
    • zh:中英混合。
    • en:英语。
    • ko:韩语。
    • ja:日语。

ShowPriority

Integer

1

译文字幕的展示优先级。
取值越大,优先级越高。例如原文字幕的 ShowPriority 为 1,译文字幕的 ShowPriority 为 2,则译文字幕在上,原文字幕在下。

MaxCharNumber

Integer

60

译文每行字幕的最大字符数。

说明

  • 系统会综合您传入的该参数取值以及 MarginLr(左右边距)、Font(字体)、FontSize(字号)和屏幕分辨率等因素,计算出每行最终可显示的最大字符数。
  • 每个文字、字母、符号或数字均为一个字符。
  • MaxRowNumber 取值为 12 时,如果译文的字幕总字数超出显示范围,内容将会被截断。例如每行字幕的最大字符数为 10,MaxRowNumber 取值 2,则当译文字幕总字数超出 20 时,20 字后的内容会被截断。
  • 如传入 DisplayPreset(预设效果配置),该参数配置不生效。

Hidden

Boolean

false

是否隐藏译文字幕。取值如下:

  • true:隐藏。
  • false:显示。

Font

String

inter

译文字幕的字体。

  • 当 SIConfig 下的 Enable 取值为 true 使用声影同传模式时,您可调用 GetSubtitleTranscodePresetConfig 并通过 Alias 参数获取字体对应的中文名称。
  • 当 SIConfig 下的 Enable 取值为 false 使用纯字幕模式时,具体取值如下。译文字幕语言(Language 取值)不同,译文字幕字体也随之不同。
    • 当译文字幕的语言是 zh 时,支持以下字体取值。
      • siyuanheiti:思源黑体。
      • songtixi:宋体细。
      • songticu:宋体粗。
      • heitifan:黑体繁。
      • kaiti:楷体。
    • 当译文字幕的语言是 en 时,支持以下字体取值。
      • inter:Inter。
      • roboto:Roboto。
      • opposans:OPPOSans。
      • siyuansongti:思源宋体。
      • montserrat:Montserrat。
    • 当译文字幕的语言是 ko 或 ja 时,支持 notosans(Noto Sans) 字体。

FontSize

Integer

18

译文字幕字号。单位为 px。

说明

如传入 DisplayPreset(预设效果配置),该参数配置不生效。

FontColor

String

0xFF0000@0.5

译文字幕的字体颜色。
取值支持以下表示方式:

  • 以 0x 或 # 开头的十六进制 RGB 颜色值,并可通过 @ 符号附加透明度,透明度支持十六进制(如 0x80)或小数(如 0.5)两种表示方式。例如,0xFF0000@0x800xFF0000@0.5#FF0000@0x80#FF0000@0.5 表示 RGB 值为 FF0000,透明度为 50% 的颜色。
  • FFmpeg 规定的颜色关键字,并可通过 @ 符号附加透明度,透明度支持用小数(如 0.5)表示。例如,AliceBlue@0.5 表示 RGB 值为 0xF0F8FF,透明度为 50% 的颜色。

说明

BorderObject of Border-译文字幕字体阴影。
BoxObject of Box-译文字幕字体背景。

SubtitleTosConfig

参数类型示例值描述

Enable

Boolean

true

是否生成字幕 SRT 文件。取值如下:

  • true:生成。
  • false:不生成。
BucketStringbucketa存储字幕 SRT 文件的 TOS 桶名称。

Region

String

cn-beijing

存储字幕 SRT 文件的 TOS 桶区域。取值如下:

  • cn-beijing:华北2(北京)
  • cn-guangzhou:华南1(广州)
  • cn-shanghai:华东2(上海)
StorageDirStringFolderA存储字幕 SRT 文件的 TOS 桶文件夹名称。

Border

参数类型示例值描述
WidthFloat2宽度。单位为 px。

Color

String

0xFF0000@0.5

颜色。
取值支持以下表示方式:

  • 以 0x 或 # 开头的十六进制 RGB 颜色值,并可通过 @ 符号附加透明度,透明度支持十六进制(如 0x80)或小数(如 0.5)两种表示方式。例如,0xFF0000@0x800xFF0000@0.5#FF0000@0x80#FF0000@0.5 表示 RGB 值为 FF0000,透明度为 50% 的颜色。
  • FFmpeg 规定的颜色关键字,并可通过 @ 符号附加透明度,透明度支持用小数(如 0.5)表示。例如,AliceBlue@0.5 表示 RGB 值为 0xF0F8FF,透明度为 50% 的颜色。

说明

Box

参数类型示例值描述
WFloat1.0宽度。单位为 px。

Color

String

0xFF0000@0.5

颜色。
取值支持以下表示方式:

  • 以 0x 或 # 开头的十六进制 RGB 颜色值,并可通过 @ 符号附加透明度,透明度支持十六进制(如 0x80)或小数(如 0.5)两种表示方式。例如,0xFF0000@0x800xFF0000@0.5#FF0000@0x80#FF0000@0.5 表示 RGB 值为 FF0000,透明度为 50% 的颜色。
  • FFmpeg 规定的颜色关键字,并可通过 @ 符号附加透明度,透明度支持用小数(如 0.5)表示。例如,AliceBlue@0.5 表示 RGB 值为 0xF0F8FF,透明度为 50% 的颜色。

说明

请求示例

POST https://live.volcengineapi.com?Action=DescribeSubtitleTranscodePresetDetail&Version=2023-01-01
{
    "PresetList": [
        "igx**dqjks",
        "iga**dqjks"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeSubtitleTranscodePresetDetail",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "PresetDetailList": [
            {
                "PresetName": "igxxjdqjks",
                "Status": 1,
                "Description": "subtitleconfig001",
                "SuffixName": "_subtitle",
                "Delay": 8,
                "DisplayPreset": "small",
                "MaxRowNumber": 0,
                "Position": {
                    "Relative": "top",
                    "MarginVertical": 0.5,
                    "MarginHorizontal": 0.2
                },
                "SourceLanguage": {
                    "Display": true,
                    "Language": "zh",
                    "Font": "siyuanheiti",
                    "FontSize": 18,
                    "Border": {
                        "Width": 2,
                        "Color": "0xFF0000@0.5"
                    },
                    "FontColor": "0xFF0000@0.5",
                    "ShowPriority": 2,
                    "MaxCharNumber": 60,
                    "Box": {
                        "W": 1,
                        "Color": "0xFF0000@0.5"
                    }
                },
                "TargetLanguage": [
                    {
                        "Language": "en",
                        "Font": "inter",
                        "FontSize": 18,
                        "FontColor": "0xFF0000@0.5",
                        "Border": {
                            "Width": 2,
                            "Color": "0xFF0000@0.5"
                        },
                        "ShowPriority": 1,
                        "MaxCharNumber": 60,
                        "Hidden": true,
                        "Box": {
                            "W": 1.0,
                            "Color": "0xFF0000@0.5"
                        }
                    }
                ],
                "HotWordList": [
                    "视频直播",
                    "赛事直播",
                    "智能家居"
                ],
                "GlossaryWordList": [
                    "字节跳动:ByteDance",
                    "视频直播:MediaLive"
                ],
                "CreatedAt": 1779335505,
                "UpdatedAt": 1779435505,
                "SubtitleTosConfig": {
                    "Enable": true,
                    "Bucket": "bucketa",
                    "Region": "cn-beijing",
                    "StorageDir": "FolderA"
                },
                "SIConfig": {
                    "Enable": true,
                    "Pipe": "mix",
                    "SpeakerRecognition": 1,
                    "DigitalHumanMouthShape": false,
                    "PipeExtra": "{\"Separator\":{\"HandleType\":1},\"Amix\":{\"AudioEnhance\":false}}"
                },
                "ReplaceMap": {
                    "蒂姆": "Tim",
                    "提姆": "Tim"
                }
            }
        ]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowedthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
404ResourceNotFound.VhostNotExistvhost not found未找到域名空间(Vhost)。请检查传入的域名空间是否与实际使用的域名空间一致。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误,请联系技术支持
500InternalError.VhostOrDomainan internal error related to vhost or domain occurred, please contact the administrator.出现与域名空间(Vhost)或域名(Domain)相关的内部错误。请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持
最近更新时间:2026.05.21 15:41:58
这个页面对您有帮助吗?
有用
有用
无用
无用