最近更新时间：2024.04.15 11:49:35
首次发布时间：2022.07.21 16:22:01
该服务为异步调用，分为任务提交和任务结果查询两步骤。
视频高光提取服务，通过分析传入的视频内容，对长视频进行高光时刻提取，计算出视频中的若干高光时刻，为用户生成高光混剪短视频片段，支持通过参数配置不同高光类型满足不同应用场景需求。目前该服务重点优化游戏以及电影/电视剧/综艺视频的高光检测效果。
| 名称 | 内容 |
|---|---|
| 视频要求 | 1.视频格式：不做限制，建议使用MP4格式. 2.视频大小不超过380MB |
| 名称 | 内容 |
|---|---|
| 接口地址 | https://visual.volcengineapi.com |
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded |
请求参数
（1）header请求参数
公共请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| X-Date | String | 是 | 使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z |
Authorization | String | 是 | HMAC-SHA256：签名方法 |
| X-Security-Token | String | 否 | 指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。 |
（2）Query参数
业务请求参数
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| Action | 必选 | String | 接口名，取值：VideoHighlightExtractionSubmitTask |
| Version | 必选 | String | 版本号，取值：2020-08-26 |
（3）Body参数
业务请求参数
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
video_url | 必选 | String | 视频链接 |
video_type | 必选 | Int | 填写视频类型，如果是游戏类视频，目前已原生支持19款游戏：0：绝地求生，1：第五人格，2：欢乐斗地主，3：王者荣耀，4：英雄联盟，5：我的世界，6：彩虹6号，7：原神，8：崩坏3，9：古代战争，10：荒野乱斗，11：火影忍者，12：剑网3，13：跑跑卡丁车，14：炉石传说，15：模拟城市，16：植物大战僵尸，17：QQ飞车，18：贪吃蛇大作战。如果不确定游戏类别或者游戏不在支持范围内则填-1，模型会自动选择相似游戏预测高光；如果是非游戏类视频则填1000 |
| threshold | 可选 | Float | 高光阈值, 范围(0,1]，数值越大高光选取标准越高。默认为0.5，推荐使用0.5 |
| result_duration | 可选 | Int | 高光片段的时长，单位秒，正整数，默认时长为20秒。由于存在后处理策略，所以最终时长会与设定的时长有些许偏差 |
额外说明：
所有符合阈值的高光片段，如果没有符合阈值的片段则会将高光得分从高到低排列然后返回前三条高光片段；（1）通用输出参数
通用输出参数具体见通用返回字段及错误码
（2）业务输出参数
data字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
task_id | String | 任务编号，用于查询任务运行状态和结果 |
注：data字段包含在通用返回字段中，具体见通用返回字段及错误码。
（3）输出示例
{ "status": 10000, "code": 10000, "time_elapsed": "570.835792ms", "request_id": "69048264100455403521607655177", "message": "Success", "data": { "task_id": {任务id} } }
（1）通用错误码
请参考通用返回字段及错误码
（2）业务错误码
| http code | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | 10000 | Success | 成功 |
| 400 | 50201 | Missing Input Parameters: {param} | 缺少输入参数param，param可能为video、 video_type |
| 400 | 50208 | Invalid Input Video: video too large to process | 输入视频过大，超过限制 |
| 500 | 50500 | Internal Error | 服务内部错误 |
注：其余请参考通用返回字段及错误码。
| 名称 | 内容 |
|---|---|
| 请求方式 | GET |
| Content-Type | application/x-www-form-urlencoded |
Query参数：
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| Action | 必选 | String | 接口名，取值：VideoHighlightExtractionQueryTask |
| Version | 必选 | String | 版本号，取值：2020-08-26 |
task_id | 必选 | String | 任务ID |
（1）通用输出参数
通用输出参数具体见通用返回字段及错误码
（2）业务输出参数
data字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
status | String | 任务运行状态，可能为：Pending、Running、Success、Failed |
highlights | [highlight] | 处理后的高光片段信息，可能包含多个片段，仅当status为Success时该值有效，当status为Failed时请查看错误码。 |
注：data字段包含在通用返回字段中，具体见通用返回字段及错误码。
highlight字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
start_sec | int | 高光片段的对应于原图的开始时间点，单位为秒 |
end_sec | int | 高光片段的对应于原图的结束时间点，单位为秒 |
confidence | int | 高光片段的置信度，置信度越高，越符合高光标准 |
url_ | string | 处理后的高光短视频链接 |
（3）输出示例
{ "status": 10000, "code": 10000, "time_elapsed": "570.835792ms", "request_id": "69048264100455403521607655177", "message": "Success", "data": { "status": "Success" "highlights": [ { "start_sec": 0, "end_sec": 5, "confidence": 0.9979286528736391, "url_": "xxxxx" }, .... { "start_sec": 25, "end_sec": 30, "confidence": 0.9989520130966929, "url_": "xxxxxx" } ] } }
（1）通用错误码
请参考通用返回字段及错误码。
（2）业务错误码
| http code | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | 10000 | Success | 成功 |
| 400 | 50201 | Missing Input Parameters: task_id | 缺少输入参数task_id |
| 400 | 50200 | Invalid Input Parameters: task_id | 输入参数task_id无效 |
| 500 | 50500 | Internal Error | 服务内部错误 |
| 500 | 50502 | Processing time is too long, exceeding the limit | 服务处理超时 |