GetVideo - 获取一个视频的信息

调用GetVideo获取媒体集中一个视频的信息。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:GetVideo
*全部资源
*

请求参数

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

项目名称。

immvideotest
SetIdstring

媒体集的唯一标识。

videoset
VideoUristring

视频的 OSS URI。

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

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

返回参数

名称类型描述示例值
object
ModifyTimestring

视频的修改时间。

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

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

视频处理的状态。

Success
VideoWidthinteger

视频画面的宽度。

1080
SourceTypestring

源数据的类型。

video
SourceUristring

视频的 OSS URI。

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

视频信息。

{"MediaStreams":{"VideoStreams":[{"Index":0,"Language":"eng","CodecName":"h264","CodecLongName":"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10","Profile":"Baseline","CodecTimeBase":"1373627/83160000","CodecTagString":"avc1","CodecTag":"0x31637661","Width":1080,"Height":1920,"SampleAspectRatio":"1:1","DisplayAspectRatio":"9:16","PixelFormat":"yuv420p","Level":40,"FrameRrate":"90000/1","AverageFrameRate":"41580000/1373627","TimeBase":"1/90000","StartTime":"0.000000","Duration":"15.262522","Bitrate":"13091201","Frames":"462"}],"AudioStreams":[],"SubtitleStreams":[]},"MediaFormat":{"NumberStreams":2,"FormatName":"mov,mp4,m4a,3gp,3g2,mj2","FormatLongName":"QuickTime / MOV","Size":"25115517","Duration":"15.263000","StartTime":"0.000000","Bitrate":"13164131","CreationTime":"2020-10-25T09:16:09.000000Z","Address":{},"Tag":{}}}
VideoFrameTagsModifyTimestring

视频帧标签识别的更新时间。

1970-01-01T00:00:00Z
RemarksAstring

标记信息。

AdminGroup/AdminUserA/
VideoFacesFailReasonstring

视频人脸识别的失败原因。

Timeout
RemarksBstring

标记信息。

nas://path/to/file
VideoFacesStatusstring

视频人脸识别的状态。

Success
RemarksCstring

标记信息。

remarkc
VideoOCRModifyTimestring

OCR 识别的更新时间。

1970-01-01T00:00:00Z
RemarksDstring

标记信息。

remarkd
VideoHeightinteger

视频画面的高度。

1920
SourcePositionstring

视频中该图片帧处于源视频的时间轴位置。格式为 00000000.010,即%8.3f。

00000000.010
VideoOCRFailReasonstring

OCR 识别的失败原因。

Timeout
VideoFrameTagsStatusstring

视频帧标签识别的状态。

Success
VideoTagsFailReasonstring

视频标签处理的失败原因。

Timeout
VideoTagsModifyTimestring

视频标签处理的更新时间。当 VideoTagsStatus 更改时更新。

2021-01-21T07:40:53.95Z
VideoOCRStatusstring

OCR 识别的状态。

Success
VideoFramesinteger

帧数。

462
RequestIdstring

当次请求的 Request ID。

5FC2B195-B43E-45ED-9BEC-169358550193
ProcessModifyTimestring

视频处理的更新时间。

2021-01-21T07:40:53.955Z
VideoSTTModifyTimestring

语音转文字的更新时间。

2021-01-21T07:40:53.95Z
ProcessFailReasonstring

视频处理的失败原因。

Timeout
CreateTimestring

视频加入媒体集的时间。

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

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

externalId001
VideoSTTFailReasonstring

语音转文字的失败原因。

Timeout
VideoUristring

视频的 OSS URI。

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

视频帧标签识别的失败原因。

Timeout
VideoFormatstring

视频格式。

mov,mp4,m4a,3gp,3g2,mj2
VideoSTTStatusstring

语音转文字的状态。

Success
VideoFacesModifyTimestring

视频人脸识别的更新时间。

1970-01-01T00:00:00Z
VideoTagsarray<object>

视频标签处理结果。

VideoTagsobject
TagNamestring

标签名称。

大型超市
TagConfidencefloat

标签置信度。

0.8933850526809692
TagLevelinteger

标签级别,取值范围为 1~4。

2
ParentTagNamestring

父级标签名称。

内部场景
VideoDurationfloat

视频时长,单位为秒。

15.263
SetIdstring

媒体集的唯一标识。

videoset
VideoTagsStatusstring

视频标签处理的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

Success
FileSizeinteger

文件大小,单位为字节。

25115517

示例

正常返回示例

JSON格式

{
  "ModifyTime": "2021-01-21T07:40:41.683Z",
  "ProcessStatus": "Success",
  "VideoWidth": 1080,
  "SourceType": "video",
  "SourceUri": "oss://imm-test/testcases/video.mp4",
  "VideoInfo": "{\"MediaStreams\":{\"VideoStreams\":[{\"Index\":0,\"Language\":\"eng\",\"CodecName\":\"h264\",\"CodecLongName\":\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\",\"Profile\":\"Baseline\",\"CodecTimeBase\":\"1373627/83160000\",\"CodecTagString\":\"avc1\",\"CodecTag\":\"0x31637661\",\"Width\":1080,\"Height\":1920,\"SampleAspectRatio\":\"1:1\",\"DisplayAspectRatio\":\"9:16\",\"PixelFormat\":\"yuv420p\",\"Level\":40,\"FrameRrate\":\"90000/1\",\"AverageFrameRate\":\"41580000/1373627\",\"TimeBase\":\"1/90000\",\"StartTime\":\"0.000000\",\"Duration\":\"15.262522\",\"Bitrate\":\"13091201\",\"Frames\":\"462\"}],\"AudioStreams\":[],\"SubtitleStreams\":[]},\"MediaFormat\":{\"NumberStreams\":2,\"FormatName\":\"mov,mp4,m4a,3gp,3g2,mj2\",\"FormatLongName\":\"QuickTime / MOV\",\"Size\":\"25115517\",\"Duration\":\"15.263000\",\"StartTime\":\"0.000000\",\"Bitrate\":\"13164131\",\"CreationTime\":\"2020-10-25T09:16:09.000000Z\",\"Address\":{},\"Tag\":{}}}",
  "VideoFrameTagsModifyTime": "1970-01-01T00:00:00Z",
  "RemarksA": "AdminGroup/AdminUserA/",
  "VideoFacesFailReason": "Timeout",
  "RemarksB": "nas://path/to/file",
  "VideoFacesStatus": "Success",
  "RemarksC": "remarkc",
  "VideoOCRModifyTime": "1970-01-01T00:00:00Z",
  "RemarksD": "remarkd",
  "VideoHeight": 1920,
  "SourcePosition": "00000000.010",
  "VideoOCRFailReason": "Timeout",
  "VideoFrameTagsStatus": "Success",
  "VideoTagsFailReason": "Timeout",
  "VideoTagsModifyTime": "2021-01-21T07:40:53.95Z",
  "VideoOCRStatus": "Success",
  "VideoFrames": 462,
  "RequestId": "5FC2B195-B43E-45ED-9BEC-169358550193",
  "ProcessModifyTime": "2021-01-21T07:40:53.955Z",
  "VideoSTTModifyTime": "2021-01-21T07:40:53.95Z",
  "ProcessFailReason": "Timeout",
  "CreateTime": "2021-01-21T07:40:41.683Z",
  "ExternalId": "externalId001",
  "VideoSTTFailReason": "Timeout",
  "VideoUri": "oss://imm-test/testcases/video.mp4",
  "VideoFrameTagsFailReason": "Timeout",
  "VideoFormat": "mov,mp4,m4a,3gp,3g2,mj2",
  "VideoSTTStatus": "Success",
  "VideoFacesModifyTime": "1970-01-01T00:00:00Z",
  "VideoTags": [
    {
      "TagName": "大型超市",
      "TagConfidence": 0.8933850526809692,
      "TagLevel": 2,
      "ParentTagName": "内部场景"
    }
  ],
  "VideoDuration": 15.263,
  "SetId": "videoset",
  "VideoTagsStatus": "Success",
  "FileSize": 25115517
}

错误码

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