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

视频直播

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

调用 RestartSpeechTask 接口，重启运行中或启动中的声影同传或字幕任务（非纯字幕模式）。您也可以选择不中断直播，仅重启任务中的字幕算法模块。

使用说明

您可调用本接口，重启运行中或启动中的声影同传或字幕任务（非纯字幕模式）。当 SetSiStatus 取值为 reload 时，您也可以选择不中断直播，仅重启任务中的字幕算法模块。

  • 声影同传任务：请求参数必须传入 TaskID。您可通过调用 GetSpeechTask 接口获取任务状态（Status），确保任务状态为运行中（running）或启动中（prepare）。
  • 字幕任务（非纯字幕模式）：请求参数必须传入 PushDomain、AppName、StreamName 和 SuffixName。

注意事项

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

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=RestartSpeechTask&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是RestartSpeechTask接口名称。当前 API 的名称为 RestartSpeechTask。
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 获取字幕后缀。

SetSiStatus

String

否

reload

重启方式。默认值为空。取值如下：

  • reload：不中断直播，仅重启任务中的字幕算法模块。
  • 其他取值或空值：中断直播，并重启任务。

返回参数

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

参数类型示例值描述
CodeInteger0状态码。
MessageStringsuccess状态信息。

请求示例 

POST https://live.volcengineapi.com?Action=RestartSpeechTask&Version=2023-01-01
{
    "TaskID": "ab5d68****257f3f",
    "SetSiStatus": "reload"
}

返回示例 

{
    "ResponseMetadata": {
        "RequestID": "2025111815174611F9EB957342DF410655",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "RestartSpeechTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Code": 0,
        "Message": "success"
    }
}

错误码

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

Last updated: 2026.05.21 11:35:44