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

视频直播

Copy page
Download PDF
声影同传
UpdateSpeechTask - 更新声影同传任务
Copy page
Download PDF
UpdateSpeechTask - 更新声影同传任务

调用 UpdateSpeechTask 接口,更新声影同传任务的功能开启状态,常用于在直播期间按需开启和关闭翻译状态。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 计费说明:仅收取声影同传费用。声影同传按同传任务的实际推流时长计费。详见声影同传计费

请求说明

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

调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
TaskIDString497430****75c378任务 ID。可通过调用 CreateSpeechTaskSearchSpeechTask 获取 ID。

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.04.13 19:34:12