文档

IndexVideo - 对视频进行自动截帧、分组、识别操作

更新时间:

调用IndexVideo接口将视频添加到媒体集中,并对视频进行自动截帧、分组、识别等操作。

接口说明

此接口已不再维护,建议使用新版(2020-09-30 版本)接口 IndexFileMeta 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Projectstring

项目名称。

immvideotest
SetIdstring

媒体集的唯一标识。

videotest
VideoUristring

视频的 OSS URI。

OSS 地址规则为oss://bucket/object,其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称,object 为文件路径。

oss://imm-test/testcases/video.mp4
RemarksAstring

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
AdminGroup/AdminUserA/
RemarksBstring

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
nas://path/to/file
TgtUristring

存储数据的 OSS 地址。不支持此参数。

oss://imm-test/testcases
RemarksCstring

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
remarkc
RemarksDstring

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
remarkd
ExternalIdstring

外部 ID,用于和您的应用层的 ID(如果有)进行绑定。

externalId001
NotifyTopicNamestring

异步反向通知的 TopicName。

topic2
NotifyEndpointstring

异步反向通知的 Endpoint,视频处理结果可以通过该 Endpoint 异步通知给调用者。使用此功能需要先开通 MNS 服务,新建 topic 和 queue,并配置订阅关系。具体操作,请参见消息服务 MNS 快速入门概述

说明 MNS 服务和智能媒体管理必须处于同一地域。
http://1111111111.mns.cn-hangzhou.aliyuncs.com

返回参数

名称类型描述示例值
object
ModifyTimestring

视频的修改时间。

添加视频后,如果未修改过视频,则视频的修改时间和视频加入媒体集的时间相同。

2021-01-21T07:40:41.683Z
RequestIdstring

当次请求的 Request ID。

896ABAD1-C452-4BED-B5E0-302955F8BAB5
CreateTimestring

视频加入媒体集的时间。

2021-01-21T07:40:41.683Z
ExternalIdstring

外部 ID,用于和您的应用层的 ID(如果有)进行绑定。

externalId001
VideoUristring

视频的 OSS URI。

oss://imm-test/testcases/video.mp4
RemarksAstring

标记信息。

如果请求时未设置此参数,则返回值为空。

AdminGroup/AdminUserA/
RemarksBstring

标记信息。

如果请求时未设置此参数,则返回值为空。

nas://path/to/file
RemarksCstring

标记信息。

如果请求时未设置此参数,则返回值为空。

remarkc
RemarksDstring

标记信息。

如果请求时未设置此参数,则返回值为空。

remarkd
SetIdstring

媒体集的唯一标识。

videoset

示例

正常返回示例

JSON格式

{
  "ModifyTime": "2021-01-21T07:40:41.683Z",
  "RequestId": "896ABAD1-C452-4BED-B5E0-302955F8BAB5",
  "CreateTime": "2021-01-21T07:40:41.683Z",
  "ExternalId": "externalId001",
  "VideoUri": "oss://imm-test/testcases/video.mp4",
  "RemarksA": "AdminGroup/AdminUserA/",
  "RemarksB": "nas://path/to/file",
  "RemarksC": "remarkc",
  "RemarksD": "remarkd",
  "SetId": "videoset"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈