视频分析接口

提交视频分析

用户提供视频路径,创建一次视频分析。

  • 视频路径支持BOS、VOD、HTTP(S) URL路径;
  • 正在分析中的视频无法再次进行分析;
  • 已经分析过的视频(FINISHED/ERROR)可以重新进行分析;
  • 视频重新分析会覆盖上次分析结果。

请求语法

PUT /v<version>/media HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json

v1v2均支持

请求参数

请求体

参数 类型 描述 是否必须
source String 视频路径,不超过1024字符
auth String 视频路径鉴权参数,仅URL视频使用
title String 视频标题,默认不设置,不超过256字符 否,如果没有设置title,对于VOD媒资,VCA会主动去VOD查询标题
description String 视频描述,默认空字符串,不超过256字符
preset String 分析模板名称,若为空会使用默认模板
notification String 通知名称

说明:

  1. 对于 BOS 视频,source="bos://<bos-bucket>/<bos-object>", 例如"bos://testbucket/dir/video.mp4",由客户保证 BOS 路径可访问。
  2. 对于 VOD 媒资,source="vod://<vod-media-id>",例如"vod://mda-fhepatsnpn4rk9z",VCA 会内部请求VOD获取源视频地址,需要确保媒资在VOD状态为PUBLISHED。
  3. 对于 VOD 媒资转码后的视频,source="vod://<vod-media-id>-<vod-preset>", 例如"vod://mda-abc-default",注意这里使用“-”作为分隔符。(补充知识:VOD中媒资ID由系统生成,形如mda-xxx,共计20个字符;VOD模板名由数字、字母和下划线组成,不超过40字符)
  4. 对于HTTP/HTTPS视频,source="<http(s)-url>", 例如"http://domain/dir/video.mp4",url中可以包含参数,例如"http://domain/dir/video?id=abc"。另外,为了优化客户使用体验,VCA 支持将HTTP/HTTPS视频URL中的临时参数(主要是鉴权参数)通过auth="<key1>=<value1>&<key2>=<value2>"和其它参数进行区分,auth中可以包含多个参数,用&进行分割,例如"token=abcxyz&timestamp=1514993900", VCA内部会使用?&将source和auth拼接,得到完整的原视频URL并拉取进行分析。客户需保证实际拉取的URL可访问。客户仅需通过source即可查询视频分析结果,同时分析回调中也仅返回source

请求示例

示例一:分析BOS类型媒资

PUT /v1/media HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

{
    "source": "bos://samplebucket/sample.mp4", // 也支持图片bos://demobucket/demo.jpg
    "preset": "customer_preset_name",
    "notification": "customer_notification_name"
}

示例二:分析 VOD 媒资原视频

PUT /v1/media HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

{
  "source": "vod://mda-fhepatsnpn4rk9z",
  "preset": "customer_preset_name",
  "notification": "customer_notification_name"
}

示例三:分析 VOD 媒资转码后视频

PUT /v1/media HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
  "source": "vod://mda-fhepatsnpn4rk9z-mp4",
  "preset": "customer_preset_name",
  "notification": "customer_notification_name"
}

示例四:分析 URL 视频

PUT /v1/media HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

{
    "source": "https://vca-customer.baidu.com/media.mp4", // 也支持图片https://vca-customer.baidu.com/media.jpg
    "preset": "customer_preset_name",
    "notification": "customer_notification_name"
}

示例五:分析包含鉴权参数的 URL 视频

PUT /v1/media HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

{
    "source": "https://vca-customer.baidu.com/media.mp4", // 也支持图片https://vca-customer.baidu.com/media.jpg
    "auth": "authorization=some_authorization_info"
    "preset": "customer_preset_name",
    "notification": "customer_notification_name"
}

响应体

参数 类型 描述
source String 视频路径
mediaId String VOD媒资id,source为VOD路径时存在
title String 视频标题
description String 视频描述
preset String 分析模板名称
status String 分析状态
percent Number 分析进度,0 ~ 100整数
notification String 通知名称
createTime Date 创建时间

响应示例

示例一:分析 BOS 类型视频响应

HTTP/1.1 200 OK
{
    "source": "bos://samplebucket/sample.mp4",
    "preset": "customer_preset_name",
    "status": "PROVISIONING",
    "percent": 0,
    "createTime": "2018-10-09T08:05:58Z",
}

示例二:分析 VOD 媒资原视频响应

HTTP/1.1 200 OK

{
    "source": "vod://mda-fhepatsnpn4rk9z",
    "mediaId": "mda-fhepatsnpn4rk9z",
    "title": "media title",
    "preset": "customer_preset_name",
    "status": "PROVISIONING",
    "percent": 0,
    "notification": "customer_notification_name",
    "createTime": "2018-10-09T08:05:58Z"
}

示例三:分析 VOD 媒资转码后视频响应

HTTP/1.1 200 OK

{
    "source": "vod://mda-fhepatsnpn4rk9z-mp4",
    "mediaId": "mda-fhepatsnpn4rk9z",
    "title": "media title",
    "preset": "customer_preset_name",
    "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",
    "preset": "customer_preset_name",
    "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",
    "preset": "customer_preset_name",
    "status": "PROVISIONING",
    "percent": 0,
    "notification": "customer_notification_name",
    "createTime": "2018-10-09T08:05:58Z"
}

查询视频分析结果

根据视频路径查询分析结果。如果有重复分析,则返回最近一次分析的结果。

请求语法

GET /v<version>/media HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json

v1v2均支持

请求参数

参数 类型 描述 是否必须
source String 视频路径,需要对source进行urlEncode。