抽帧模板接口
更新时间：2024-08-08
创建缩略图模板
接口描述
用户可以通过此接口创建缩略图Preset。
请求（Request）
-
请求语法：
Http1POST /v{version}/preset/thumbnail HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: {utc-date-string} 4connection: keep-alive 5accept: */* 6host: media.bj.baidubce.com 7x-bce-request-id: {bce-request-id} 8content-type: application/json 9authorization: {bce-authorization-string} - 请求头域：无特殊Header参数
- 请求参数（以下均为Requestbody参数）：
| 字段名称 | 字段类型 | 必要性 | 字段描述 | 可选值 | 默认值 |
|---|---|---|---|---|---|
| presetName | String | 必选 | 缩略图模板名称 | - | - |
| description | String | 可选 | 缩略图模板描述 | - | - |
| target | Object | 可选 | 目标缩略图信息的集合 | - | - |
| + format | String | 可选 | 目标缩略图的格式 | jpg、png、mp4、gif、webp | jpg |
| + sizingPolicy | String | 可选 | 目标缩略图的尺寸伸缩策略 | keep、shrinkToFit、stretch，keep表示保持原始视频宽高比，shrinkToFit表示保持原始视频宽高比并加黑边，stretch表示拉伸原始视频 | keep |
| + widthInPixel | Number | 可选 | 目标缩略图的宽，如果视频实际分辨率低于目标分辨率则按照实际分辨率输出 | 10 ~ 2000 | 600 |
| + heightInPixel | Number | 可选 | 目标缩略图的高，如果视频实际分辨率低于目标分辨率则按照实际分辨率输出 | 10 ~ 2000 | 450 |
| + frameRate | Number | 可选 | 动图的帧率，仅当format为mp4、gif、webp且mode为manual、split时可选 | 0.01 ~ 30.0 | 3.0 |
| + gifQuality | String | 可选 | gif的质量，仅当format为gif且mode为manual、split时可选 | high, medium | medium |
| + spriteOutputCfg | Object | 可选 | 雪碧图输出参数设置，仅当抽取多图（即mode=manual/split）,且输出为非动图（即format=jpg/png）时可选 | - | - |
| ++ rows | Number | 可选 | 雪碧图拼接行数 | 1 ~ 100 | 10 |
| ++ columns | Number | 可选 | 雪碧图拼接列数 | 1 ~ 100 | 10 |
| ++ margin | Number | 可选 | 外框宽度，单位：px | 1 ~ 1000 | 0 |
| ++ padding | Number | 可选 | 外框宽度，单位：px | 1 ~ 1000 | 0 |
| ++ keepCellPic | Bool | 可选 | 是否保留子图原图 | true, false | true |
| ++ spriteKeyTag | String | 可选 | 上传BOS的雪碧图的key中用于标记为雪碧图的tag，最终文件名为 {keyPrefix}+{spriteKeyTag}+{雪碧图序号%05d}，雪碧图中子图按照原视频中的顺序排列 | 字符串长度范围为1 ~ 100 | "-SPRITE-" |
| capture | Object | 可选 | 生成缩略图的规则 | - | - |
| + mode | String | 可选 | 生成缩略图的模式 | auto、manual、split、shot、idl、highlight，auto模式是系统自动截取熵值较高的一帧作为缩略图，manual模式是根据指定的起止时间和间隔时间截取缩略图，split模式是根据指定的起止时间和张数截取缩略图，shot模式根据场景切换自动截取画面(不支持输出视频格式)，idl模式时使用百度IDL（Institute of Deep Learning）智能缩略图算法截取缩略图（仅支持输出jpg格式），highlight模式自动生成一个0.5s的精彩片段（目前仅适用于竖屏小视频，只支持输出视频格式，默认为正播反播合并效果） | auto |
| + frameNumber | Number | 可选 | 生成缩略图的张数，仅当mode=split时可选 | 大于等于1 | 1 |
| + startTimeInSecond | Number | 可选 | 生成缩略图的开始时间，当mode=manual或split时可选 | 大于等于0 | 0.0 |
| + endTimeInSecond | Number | 可选 | 生成缩略图的结束时间，当mode=manual或split时可选，且不得小于start time | 大于等于0 | 视频时长 |
| + intervalInSecond | Number | 可选 | 生成缩略图的间隔时间，仅当mode=manual时可选 | 大于0 | 1.0 |
| + minIntervalInSecond | Number | 可选 | 生成缩略图的最小间隔时间，仅当mode=split时可选 | 大于0 | 1.0 |
| + skipBlackFrame | Boolean | 可选 | 是否跳过黑帧，仅当mode=manual或split时可选 | true/false | false |
| + highlightOutputCfg | Object | 可选 | highlight 模式下输出控制参数，仅当mode=highlight时可选 | - | - |
| ++ durationInSecond | Number | 可选 | 截取片段时长，单位：秒 | 0.1 ~ 7200.0 | 0.25 |
| ++ playbackSpeed | Number | 可选 | 回放速度，值低于1.0时为减速视频，高于1.0时为加速视频 | 0.05 ~ 20.0 | 1.0 |
| ++ frameRate | Number | 可选 | 输出视频帧率，单位：fps | 0.1 ~ 60.0 | 11.0 |
| ++ reverseConcat | Bool | 可选 | 正播反播合并效果 | true, false | true |
-
请求示例：
Http1POST /v3/preset/thumbnail HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: 2015-03-24T13:08:44Z 4host: media.bj.baidubce.com 5accept: */* 6connection: keep-alive 7x-bce-request-id: 3807ce30-5264-45f2-9b52-26b78e24a750 8content-type: application/json 9authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9 10 11{ 12 "presetName": "customlized_thumbnail_preset", 13 "description": "An example thumbnail preset description", 14 "container": "mp4", 15 "state": "ACTIVE", 16 "target": { 17 "format": "jpg", 18 "sizingPolicy": "keep", 19 "widthInPixel": 600, 20 "heightInPixel": 450 21 }, 22 "capture": { 23 "mode": "manual", 24 "startTimeInSecond": 0, 25 "endTimeInSecond": 1 26 } 27}
响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：无
-
响应示例：
Http1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3x-bce-request-id: 3807ce30-5264-45f2-9b52-26b78e24a750 4Cache-Control: no-cache 5Server: BWS 6Date: Tue, 24 Mar 2015 13:37:10 GMT 7Content-Type: application/json;charset=UTF-8
查询指定模板
接口描述
通过presetName查询指定的缩略图模板信息。
请求（Request）
-
请求语法：
Http1GET /v{version}/preset/thumbnail/{presetId} HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: {utc-date-string} 4host: media.bj.baidubce.com 5accept: */* 6connection: keep-alive 7x-bce-request-id: {bce-request-id} 8content-type: application/json 9authorization: {bce-authorization-string} - 请求头域：无特殊Header参数
- 请求参数：无
-
请求示例：
Http1GET /v3/preset/thumbnail/customlized_thumbnail_preset HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: 2015-03-24T13:37:10Z 4host: media.bj.baidubce.com 5accept: */* 6connection: keep-alive 7x-bce-request-id: 3807ce30-5264-45f2-9b52-26b78e24a750 8content-type: application/json 9authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:37:10Z/1800/host;x-bce-date/3e1bf9f50ae1fca2d704d61567810dde946fff3ca2e455676455a6f5c8cce596
响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：与[创建缩略图模板/请求/请求参数]保持一致，增加以下字段
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| state | String | 模板状态，ACTIVE/INACTIVE |
| createdTime | String | 模板创建的UTC格式的时间 |
-
响应示例：
Http1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3x-bce-request-id: 3807ce30-5264-45f2-9b52-26b78e24a750 4Cache-Control: no-cache 5Server: BWS 6Date: Tue, 24 Mar 2015 13:37:10 GMT 7Content-Type: application/json;charset=UTF-8 8 9{ 10 "state": "ACTIVE", 11 "createdTime": "2015-03-24T13:34:07Z", 12 "presetName": "customlized_thumbnail_preset", 13 "description": "A example thumbnail preset description", 14 "target": { 15 "format": "jpg", 16 "sizingPolicy": "keep", 17 "widthInPixel": 600, 18 "heightInPixel": 450 19 }, 20 "capture": { 21 "mode": "manual", 22 "startTimeInSecond": 0, 23 "endTimeInSecond": 1 24 } 25}
删除指定缩略图模板
接口描述
用于删除用户指定presetName的用户缩略图模板
请求（Request）
-
请求语法：
Http1DELETE /v{version}/preset/thumbnail/{presetName} HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: {utc-date-string} 4connection: keep-alive 5accept: */* 6host: media.bj.baidubce.com 7x-bce-request-id: {bce-request-id} 8content-type: application/json 9authorization: {bce-authorization-string} - 请求头域：无特殊Header参数
- 请求参数：无
-
请求示例：
Http1DELETE /v3/preset/thumbnail/customlized_thumbnail_preset HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: 2015-03-24T13:06:02Z 4connection: keep-alive 5accept: */* 6host: media.bj.baidubce.com 7x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e 8content-type: application/json 9authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:06:02Z/1800/host;x-bce-date/02f64774999996903cffa5ae4d6eef436127a96f581a4e8467497e239d824be8
响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：无
-
响应示例：
Http1HTTP/1.1 200 OK 2x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e 3Cache-Control: no-cache
更新指定模板
接口描述
用户可以通过此接口更新指定Preset。
请求（Request）
-
请求语法：
Http1PUT /v{version}/preset/thumbnail/{presetName} HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: {utc-date-string} 4connection: keep-alive 5accept: */* 6host: media.bj.baidubce.com 7x-bce-request-id: {bce-request-id} 8content-type: application/json 9authorization: {bce-authorization-string} - 请求头域：无特殊Header参数
- 请求参数：同创建模板请求
-
请求示例：
Http1PUT /v3/preset/thumbnail/customlized_thumbnail_preset HTTP/1.1 2accept-encoding: gzip, deflate 3x-bce-date: 2020-02-14T15:12:37Z 4host: media.bj.baidubce.com 5accept: */* 6connection: keep-alive 7x-bce-request-id: 0969b91e-1890-470b-b93b-97939f672e54 8content-type: application/json 9authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2020-02-14T15:12:37Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9 10 11{ 12 "presetName": "customlized_thumbnail_preset", 13 "description": "An example thumbnail preset description", 14 "target": { 15 "format": "jpg", 16 "sizingPolicy": "keep", 17 "widthInPixel": 600, 18 "heightInPixel": 450 19 }, 20 "capture": { 21 "mode": "manual", 22 "startTimeInSecond": 0, 23 "endTimeInSecond": 1 24 } 25}
响应（Response）
- 响应头域：无特殊Header参数
- 响应参数：无
-
响应示例：
Http1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3x-bce-request-id: 0969b91e-1890-470b-b93b-97939f672e54 4Cache-Control: no-cache 5Server: BWS 6Date: Fri, 14 Feb 2020 07:12:37 GMT 7Content-Type: application/json;charset=UTF-8