查询精彩视频分析结果
更新时间：2024-11-18
接口描述
根据视频路径查询分析结果。如果有重复分析，则返回最近一次分析的结果。
请求结构
GET /v{version}/highlight HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
请求头域
无
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| source | String | 是 | Query参数 | 视频路径，需要对source进行urlEncode。 |
响应头域
无
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| source | String | 视频路径 |
| description | String | 视频描述 |
| durationInSecond | Number | 视频时长，仅当status不为PROVISIONING时存在 |
| status | String | 分析状态 |
| percent | Number | 0 ~ 100整数，单位% |
| createTime | Date | 分析创建时间 |
| startTime | Date | 分析开始时间，仅当status不为PROVISIONING/CANCELLED时存在 |
| publishTime | Date | 分析结束时间，仅当status=FINISHED/ERROR/CANCELLED时存在 |
| results | Array | 分析结果，仅当status=FINISHED时存在 |
| + type | String | 标记结果类型为highlight |
| + highlightResult | Object | highlight返回结果结构体 |
| ++ results | Object | 精彩片段列表信息 |
| +++ score | Double | 分数 |
| +++ startTimeInMS | Long | 在原始视频中的开始时间（单位是ms） |
| +++ endTimeInMS | Long | 在原始视频中的结束时间（单位是ms） |
| error | Object | 分析失败信息，仅当status=ERROR时存在 |
| + code | String | 错误码 |
| + message | String | 错误信息 |
分析状态枚举如下：
| 分析状态 | 状态名称 | 描述 |
|---|---|---|
| PROVISIONING | 预处理 | 视频分析排队中 |
| PROCESSING | 分析中 | 视频分析进行中 |
| FINISHED | 分析结束 | 分析结束，可以查询分析结果 |
| ERROR | 分析失败 | 分析失败，可以查询失败错误原因 |
| CANCELLED | 分析取消 | 分析取消，视频排队时可以取消分析 |
错误码枚举如下：
| 错误码 | 错误信息 | 备注 |
|---|---|---|
| InvalidMedia | media duration/resolution exceeds limit | 视频时长/分辨率不满足MCA系统限制，请检查原视频 |
| InvalidMedia | invalid audio or video | 视频元信息中音频或视频信息不合预期，请检查原视频 |
| InvalidMedia | get media info failure | 无法获取视频元信息，请检查原视频 |
| InternalError | service internal error, please retry | 系统内部错误，建议重试 |
| TimeOut | analyze time out, please retry | 视频分析超时，请先检查原视频，如视频正常则可以重试 |
其中当错误码为TimeOut时，根据视频时长不同，超时上限也不同：
| 视频时长 | 超时上限 |
|---|---|
| <3min | 15分钟 |
| <10min | 30分钟 |
| <30min | 1小时 |
| 其它 | 2小时 + 原始视频时长的一半 |
请求示例
示例一：查询 BOS 视频分析结果
GET /v1/highlight?source=bos%3a%2f%2ftestbucket%2fdir%2fvideo.mp4 HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>示例二：查询 URL 视频分析结果
GET /v1/highlight?source=http%3a%2f%2ftest.domain.com%2fdir%2fvideo.mp4 HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>说明：
注意：如前所述，对于 URL 视频，如果在提交分析时指定了
auth参数，在查询分析结果时是不需要指定的。
响应示例
示例一：分析成功
HTTP/1.1 200 OK
{
"taskId": "mk8tbsb0n8aerix0sy9",
"source": "http://bj.bcebos.com/videoai-vio/wangzheng/test.mp4",
"description": "",
"status": "FINISHED",
"percent": 100,
"results": [
{
"highlightResult": {
"results": [
{
"endTimeInMS": 12800,
"score": 29.02,
"startTimeInMS": 0
}
]
},
"type": "highlight"
}
],
"createTime": "2021-11-09T11:18:12Z",
"startTime": "2021-11-09T11:18:21Z",
"durationInSecond": 22,
"publishTime": "2021-11-09T11:23:31Z"
}示例二：分析失败
HTTP/1.1 200 OK
{
"taskId": "mk8tbsb0n8aerix0sy9",
"source": "http://bj.bcebos.com/videoai-vio/wangzheng/test.mp4",
"description": "",
"status": "FINISHED",
"percent": 100,
"error":{
"code":"TimeOut",
"message":"analyze time out, please retry"
},
"createTime": "2021-11-09T11:18:12Z",
"startTime": "2021-11-09T11:18:21Z",
"durationInSecond": 22,
"publishTime": "2021-11-09T11:23:31Z"
}