提交分析
更新时间:2024-07-30
接口描述
用户提供视频路径,创建一次视频分析。
- 视频路径支持BOS、HTTP(S) URL路径;
- 正在分析中的视频无法再次进行分析;判断相同视频的依据是视频路径source,和视频内容无关;
- 已经分析过的视频(FINISHED/ERROR)可以重新进行分析;
- 视频重新分析会覆盖上次分析结果;
- 分析任务为异步处理模式,如果想要获取分析结果:可以设置回调参数notification,则分析完成之后会将分析结果自动回调通知notification关联的地址;也可以通过接口查询分析结果来实时获取。
请求结构
PUT /v{version}/highlight HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
请求头域
无
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
source | String | 是 | RequestBody参数 | 视频路径,不超过1024字符(分辨率需大于等于30*30且时长在6小时内) |
auth | String | 否 | RequestBody参数 | 视频路径鉴权参数,仅URL视频使用 |
description | String | 否 | RequestBody参数 | 视频描述,默认空字符串,不超过256字符 |
notification | String | 否 | RequestBody参数 | 通知名称,使用方式见通知接口 |
priority | Integer | 否 | RequestBody参数 | 优先级,取值范围是1~100,缺省值是0,值越大优先级越高;默认排队中的视频分析会按照创建时间顺序进行处理,如果有热点视频需要高优得到处理,则可以为其设置较大的优先级参数。 |
maxDurationTime | Integer | 否,默认值是600 | RequestBody参数 | 计算的视频精彩片段最大时长,单位是s,范围 [1, 1800] |
videoType | 枚举 | 否,默认值是tv | RequestBody参数 | 视频类型,可选项 news(新闻)/ tv(影视剧)/ variety(综艺) |
说明:
- 对于 BOS 视频,
source="bos://<bos-bucket>/<bos-object>"
, 例如"bos://testbucket/dir/video.mp4",由客户保证 BOS 路径可访问。- 对于HTTP/HTTPS视频,
source="<http(s)-url>"
, 例如"http://domain/dir/video.mp4
",url中可以包含参数,例如"http://domain/dir/video?id=abc
"。另外,为了优化客户使用体验,MCA 支持将HTTP/HTTPS视频URL中的临时参数(主要是鉴权参数)通过auth="<key1>=<value1>&<key2>=<value2>"
和其它参数进行区分,auth中可以包含多个参数,用&
进行分割,例如"token=abcxyz×tamp=1514993900", MCA内部会使用?
或&
将source和auth拼接,得到完整的原视频URL并拉取进行分析。客户需保证实际拉取的URL可访问。客户仅需通过source
即可查询视频分析结果,同时分析回调中也仅返回source
。
响应头域
无
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
source | String | 视频路径 |
description | String | 视频描述 |
status | String | 分析状态 |
percent | Number | 0 ~ 100整数,单位% |
notification | String | 通知名称 |
priority | Integer | 任务优先级 |
createTime | Date | 分析创建时间 |
请求示例
示例一:分析BOS类型媒资
PUT /v1/highlight HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"source": "bos://samplebucket/sample.mp4",
"notification": "customer_notification_name"
}
示例二:分析 URL 视频
PUT /v1/highlight HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"source": "https://vca-customer.baidu.com/media.mp4",
"notification": "customer_notification_name"
}
示例三:分析包含鉴权参数的 URL 视频
PUT /v1/highlight HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"source": "https://vca-customer.baidu.com/media.mp4",
"auth": "authorization=some_authorization_info",
"notification": "customer_notification_name"
}
响应示例
示例一:分析 BOS 类型视频响应
HTTP/1.1 200 OK
{
"source": "bos://samplebucket/sample.mp4",
"status": "PROVISIONING",
"percent": 0,
"createTime": "2018-10-09T08:05:58Z",
}
示例二:分析 URL 视频响应
HTTP/1.1 200 OK
{
"source": "https://vca-customer.baidu.com/media.mp4",
"status": "PROVISIONING",
"percent": 0,
"notification": "customer_notification_name",
"createTime": "2018-10-09T08:05:58Z"
}
示例三:分析包含鉴权参数的 URL 视频响应
HTTP/1.1 200 OK
{
"source": "https://vca-customer.baidu.com/media.mp4",
"status": "PROVISIONING",
"percent": 0,
"notification": "customer_notification_name",
"createTime": "2018-10-09T08:05:58Z"
}