You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

添加直播时移配置

最近更新时间：2023.10.12 17:39:58

首次发布时间：2022.04.19 20:40:35

我的收藏

添加时移模板配置

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版添加直播时移配置接口。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称
AppString是example_app应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamString否example_stream开启时移的流名称，同一个 App 最多可指定 20 路

MaxShiftTime

Integer

是

86400

最大时移时长，即观看时移的最长时间，单位为 s。支持的取值如下所示。

  • 86400
  • 259200
  • 604800
  • 1296000
PullDomainString是testpull时移拉流域名

TimeShiftType

Integer

否

0

时移类型。支持的取值如下所示。

  • 0：录制时移，即时移复用录制模板；
  • 1：独立时移，即时移不复用录制模板。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://live.volcengineapi.com?Action=CreateTimeShiftPresetV3&Version=2020-08-01
{
  "Vhost": "push.example.com",
  "App": "example_app",
  "Stream": "example_stream",
  "MaxShiftTime": 86400,
  "TimeShiftType": 0,
  "PullDomain": "testpull"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20220726*******************051B513A",
        "Action":"CreateTimeShiftPresetV3",
        "Version":"2020-08-01",
        "Service":"live",
        "Region":"cn-north-1"
    }
}

错误码

访问公共错误码获取详细信息。