请先查看接入指引了解具体接入方式,再参考此文档完成接入。
该服务为异步调用,分为任务提交和任务查询两步骤。
名称 | 内容 |
---|---|
请求方式 | POST |
Content-Type | application/x-www-form-urlencoded |
视频要求 | 1.视频格式:h264编码格式,非该格式会造成服务内部错误. 2.视频大小不超过380MB |
Query参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
Action | 必选 | String | 接口名,取值:VideoHighlightExtractionSubmitTask |
Version | 必选 | String | 版本号,取值:2020-08-26 |
Body参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
video_url | 必选 | String | 视频链接,受网络因素影响可能会导致任务失败 |
game | 必选 | Int | 必须填写,如果type为episode,该值必须为0或-1。如果type为game,则按照游戏类型填写,目前已原生支持8款游戏:0:绝地求生,1:第五人格,2:欢乐斗地主,3:王者荣耀,4:英雄联盟,5:我的世界,6:彩虹6号,7:原神,-1:非上述游戏可以选择该项,会自动选择相似游戏预测高光 |
shot_detect | 可选 | String | 可选值:{'True','False'},默认值为False 。是否调用分镜模型切分镜头,不调用时使用5s的滑动窗口,不调用速度较快 |
binary | 可选 | String | 可选值:{'True','False'},默认值为True 。是否返回高光片段的链接 |
type | 可选 | String | 可选值:{'game', 'episode'},默认值为game 。视频类型,会影响算法策略。game为游戏类别,主要针对游戏进行优化,episode为影视综类别,主要针对影视综进行优化 |
threshold | 可选 | Float | 高光阈值, 范围(0,1],数值越大高光选取标准越高。默认为0.5,推荐使用0.5 |
result_duration | 可选 | Int | 所有高光片段的总时长,单位秒 ,正整数 ,最终时长为min(result_duration, 视频时长/4),如果需要使用该值,推荐设置threshold为1.0 |
额外说明:如果错误选择type、game字段,可能会导致没有高光片段返回,或高光片段的置信度过低。
额外说明:视频片段会先切分为无数的子片段,再对所有子片段进行评估,过滤掉不符合阈值的片段,剩余片段参与高光视频合成。
目前有两种切分方案,受shot_detect
控制。
data
字段字段 | 类型 | 说明 |
---|---|---|
task_id | String | 任务编号,用于查询任务运行状态和结果 |
注:data
字段包含在通用返回字段中,具体见通用返回字段及错误码。
http code | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | 10000 | Success | 成功 |
400 | 50201 | Missing Input Parameters: {param} | 缺少输入参数param,param可能为video_url、result_duration |
400 | 50200 | Invalid Input Parameters: {param} | 输入参数param不合规,param可能为video_url、game、shot_detect、binary、definition |
400 | 50211 | Video Size Exceeds Maximum Limit: please compress the video | 输入视频过大,超过限制 |
500 | 50500 | Internal Error | 服务内部错误 |
注:其余请参考通用返回字段及错误码。
{ "status": 10000, "code": 10000, "time_elapsed": "570.835792ms", "request_id": "69048264100455403521607655177", "message": "Success", "data": { "task_id": {任务id} } }
名称 | 内容 |
---|---|
请求方式 | GET |
Content-Type | application/x-www-form-urlencoded |
是否需要鉴权 | 是 |
Query参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
Action | 必选 | String | 接口名,取值:VideoHighlightExtractionQueryTask |
Version | 必选 | String | 版本号,取值:2020-08-26 |
task_id | 必选 | String | 任务ID |
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 | 处理后的高光短视频链接,只有当binary为True时,才有可能返回该值 |
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 | 服务处理超时 |
注:其余请参考通用返回字段及错误码。
{ "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" } ] } }