文档中心

添加截图配置

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

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

调用接口添加视频直播截图配置。调用后会先增加截图模版，将新建模版加入模版库中，再将该模版绑定到对应的 App 上。

说明

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

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
回调地址配置说明：调用 UpdateCallback 和当前接口，都可以更新截图回调地址，当重复调用以上两个接口更新截图回调配置时，以最后一次调用的配置为准。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateSnapshotPreset`	接口名称。当前 API 的名称为 `CreateSnapshotPreset`。
Version	String	是	`2020-08-01`	接口版本。当前 API 的版本为 `2020-08-01`。

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间名称
App	String	是	`live`	应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
Status	Integer	否	`1`	截图模版状态状态。默认开启。 1：开启。 0：关闭。
Interval	Integer	是	`300`	截图间隔时间，单位为 s，默认值为 10，取值范围为正整数
Bucket	String	否	`live-test-tos-example`	ToS 存储的 Bucket。说明 `Bucket` 与 `ServiceID` 传且仅传一个。
StorageDir	String	否	`/`	ToS 存储目录，不传为空
SnapshotFormat	String	否	`jpeg`	截图格式。默认值为 jpeg，支持如下取值。 jpeg png
SnapshotObject	String	否	`{PushDomain}/{App}/{Stream}/{UnixTimestamp}`	存储规则。存储在 ToS 时传，格式为`{PushDomain}/{App}/{Stream}/{UnixTimestamp}`
CallbackDetailList	Array of CallbackDetailList	否	`-`	回调详情
ServiceID	String	否	`WMK***UX`	veImageX 的服务 ID。说明 `Bucket` 与 `ServiceID` 传且仅传一个。

CallbackDetailList

参数	类型	是否必选	示例值	描述
CallbackType	String	否	`http`	回调类型。默认值为 http
URL	String	否	`https://example.com/api/callback`	回调地址

返回参数

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

示例

请求示例

POST https://live.volcengineapi.com?Action=CreateSnapshotPreset&Version=2020-08-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "Interval ": 300,
  "ServiceID": "xxserID"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "CreateSnapshotPreset",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

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