请先查看接入指引了解具体接入方式,再参考此文档完成接入。
该服务为异步调用,分为任务提交和任务查询两步骤。
名称 | 内容 |
---|---|
请求方式 | POST |
Content-Type | application/x-www-form-urlencoded |
是否需要鉴权 | 是 |
视频要求 | 1.视频格式:h264编码格式,非该格式会造成服务内部错误. 2.视频大小不超过380MB |
Query参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
Action | 必选 | String | 接口名,取值:VideoSummarizationSubmitTask |
Version | 必选 | String | 版本号,取值:2020-08-26 |
Body参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
video_url | 必选 | String | 视频链接,受网络因素影响可能会导致任务失败 |
result_duration | 必选 | Int | 视频超分输出时长,单位s,若大于原视频长度则返回原视频 |
result_width | 可选 | Int | 输出视频结果的宽度(像素),如果不设置则默认为360p,即宽度为640,宽度与分辨率的关系如下 |
result_width参数与输出视频分辨率的关系
输入 | 输出 |
---|---|
width >= 1920 | definition = 1080p |
width >= 1280 | definition = 720p |
width >= 848 | definition = 480p |
width >= 640 | definition = 360p |
data
字段字段 | 类型 | 说明 |
---|---|---|
task_id | String | 任务编号,用于查询任务运行状态和结果 |
注:data
字段包含在通用返回字段中,具体见通用返回字段及错误码。
http code | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | 10000 | Success | 成功 |
400 | 50201 | Missing Input Parameters: {param} | 缺少输入参数param,param可能为video、result_duration |
400 | 50200 | Invalid Input Parameters: {param} | 输入参数param不合规,param可能为video、result_duration、result_width |
400 | 50200 | Invalid Input Parameters: Video Unchanged | 输入参数不合规,视频不需要任何处理 |
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 | 接口名,取值:VideoSummarizationQueryTask |
Version | 必选 | String | 版本号,取值:2020-08-26 |
task_id | 必选 | String | 任务ID |
data
字段字段 | 类型 | 说明 |
---|---|---|
status | String | 任务运行状态,可能为:Pending、Running、Success、Failed |
video_url | String | 处理后的视频链接,链接有效时长为1h,超过请重新请求该接口获取,仅当status为Success时该值有效,当status为Failed时请查看错误码。 |
注:部分视频编码无法在浏览器正常播放,可尝试下载后使用视频播放器播放。
注:data
字段包含在通用返回字段中,具体见通用返回字段及错误码。
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" "video_url": {视频链接} } }