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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String IndexVideo

操作接口名称,固定取值为IndexVideo。

Project String immvideotest

项目名称。

SetId String videotest

媒体集的唯一标识。

VideoUri String oss://imm-test/testcases/video.mp4

视频的OSS URI。

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

RemarksC String remarkc

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

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

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

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com,例如当RegionId为cn-hangzhou时,地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

RemarksA String AdminGroup/AdminUserA/

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

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

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

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

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

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

存储数据的OSS地址。其中视频的截帧图片存放在imgs中,语音存放在audio中。

如果未设置此参数,则视频处理后的数据默认保存在视频文件所在的OSS地址中。

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

RemarksD String remarkd

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

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

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

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

NotifyTopicName String topic2

异步反向通知的TopicName。

NotifyEndpoint String http://1111111111.mns.cn-hangzhou.aliyuncs.com

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

说明 MNS服务和智能媒体管理必须处于同一地域。

返回数据

名称 类型 示例值 描述
CreateTime String 2021-01-21T07:40:41.683Z

视频加入媒体集的时间。

ExternalId String externalId001

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

ModifyTime String 2021-01-21T07:40:41.683Z

视频的修改时间。

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

RemarksA String AdminGroup/AdminUserA/

标记信息。

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

RemarksB String nas://path/to/file

标记信息。

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

RemarksC String remarkc

标记信息。

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

RemarksD String remarkd

标记信息。

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

RequestId String 896ABAD1-C452-4BED-B5E0-302955F8BAB5

当次请求的Request ID。

SetId String videoset

媒体集的唯一标识。

VideoUri String oss://imm-test/testcases/video.mp4

视频的OSS URI。

示例

请求示例

http(s)://[Endpoint]/?Action=IndexVideo
&Project=immvideotest
&SetId=videotest
&VideoUri=oss://imm-test/testcases/video.mp4
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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