You need to enable JavaScript to run this app.
视频直播

视频直播

  • Documentation
    • 视频直播API 参考声影同传和字幕配置UpdateSpeechTask - 更新声影同传或字幕任务
Copy page
Download PDF
声影同传和字幕配置
UpdateSpeechTask - 更新声影同传或字幕任务
Copy page
Download PDF
UpdateSpeechTask - 更新声影同传或字幕任务

调用 UpdateSpeechTask 接口，更新声影同传或字幕任务（非纯字幕模式）的功能开启状态，常用于在直播期间按需开启和关闭翻译状态。

使用说明

您可调用本接口，更新声影同传或字幕任务（非纯字幕模式）的功能开启状态。

  • 声影同传任务：请求参数必须传入 TaskID。
  • 字幕任务（非纯字幕模式）：请求参数必须传入 PushDomain、AppName、StreamName 和 SuffixName。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 计费说明：
    • 声影同传任务：按同传任务的实际推流时长计费。详见声影同传计费。
    • 字幕任务
      • 字幕费用：按字幕任务的实际运行时长计费。详见字幕计费。
      • 转码费用：如果您拉取的是转码流，则会产生转码费用。转码按实际转码时长计费。详见转码计费。

请求说明

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

调试

API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Go to debug

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
TaskIDString否ab5d68****257f3f声影同传任务 ID。您可通过调用 CreateSpeechTask 或 SearchSpeechTask 获取 ID。
PushDomainString否push.example.com字幕任务对应的推流域名。例如推流地址为 rtmp://push.example.com/live/test?authinfo，则推流域名为 push.example.com。
AppNameString否live字幕任务推流地址中的 AppName。例如推流地址为 rtmp://push.example.com/live/test?authinfo，则 AppName 为 live。
StreamNameString否test字幕任务推流地址中的 StreamName。例如推流地址为 rtmp://push.example.com/live/test?authinfo，则 StreamName 为 test。

SuffixName

String

否

_subtitle

字幕任务的字幕后缀。例如字幕流地址为 rtmp://pull.example.com/live/test_subtitle，则字幕后缀为 _subtitle。
您可调用 ListVhostSubtitleTranscodePreset，并通过返回参数 SuffixName 获取字幕后缀。

Switch

String

是

AllDisable

开关状态。取值如下：

  • AllDisable：同时关闭当前模式下的所有功能。
  • AllEnable：开启当前模式下在创建声影同传任务或添加字幕配置时已启用的所有功能。
    例如，在一场面向国内观众的直播中，您可以仅在海外嘉宾发言时，将取值设置为 AllEnable，以输出同传处理后的内容，在其他时间，则将取值设置为 AllDisable，以输出未经同传处理的原始内容。

tip

  • 该参数的取值变化不会中断任务，因此任务仍会继续计费。
  • 取值为 AllDisable 时，对原声音量的配置也会失效。

返回参数

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

参数类型示例值描述
CodeInteger0状态码。
MessageStringsuccess状态信息。
DataObject of Data-任务信息。

Data

参数类型示例值描述
OptIDInteger2任务更新序列号。

请求示例 

POST https://live.volcengineapi.com?Action=UpdateSpeechTask&Version=2023-01-01
{
    "TaskID": "497430****75c378",
    "Switch": "AllDisable"
}

返回示例 

{
    "ResponseMetadata": {
        "RequestID": "20251117142336C37E6DC6C26C2529018E",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateSpeechTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Code": 0,
        "Message": "success",
        "Data": {
            "OptID": 2
        }
    }
}

错误码

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

Last updated: 2026.06.02 16:04:52