获取视频信息

最近更新时间:2019-05-09 18:14:26

接口名称

GetVideoInfo

功能说明

  1. 该接口可以获取单个视频的多种信息,包括:
    • 基础信息(basicInfo):包括视频名称、大小、时长和封面图片等;
    • 元信息(metaData):包括视频流信息和音频流信息等;
    • 加密信息(drm):对视频加密之后,相关的加密信息;
    • 内容审核结果信息(contentReviewInfo):对视频发起内容审核后的审核结果,目前仅支持鉴黄结果;
    • 智能分析结果信息(aiAnalysisInfo):对视频发起智能分析后的分析结果,包括智能分类和智能标签等;
    • 转码结果信息(transcodeInfo):包括该视频转码生成的各种码率的视频的地址、规格、码率和分辨率等;
    • 转动图结果信息(animatedGraphicsInfo):对视频转动图(如 gif)后,动图相关信息;
    • 采样截图信息(sampleSnapshotInfo):对视频采样截图后,相关截图信息;
    • 雪碧图信息(imageSpriteInfo):对视频截取雪碧图之后,雪碧的相关信息;
    • 指定时间点截图信息(snapshotByTimeOffsetInfo):对视频依照指定时间点截图后,各个截图的信息。
    • 视频打点信息(keyFrameDescInfo):对视频设置的各个打点信息。
  2. 可以指定回包只返回部分信息。

请求方式

请求域名

vod.api.qcloud.com

最高调用频率

100次/分钟

参数说明

参数名称 必填 类型 说明
fileId String 希望获取的视频的 ID
infoFilter.n String 指定需要返回的信息,可同时指定多个信息,n 从0开始递增。如果未填写该字段,默认返回所有信息。选项有:
COMMON_PARAMS 参见 公共参数

请求示例

获取视频所有信息

https://vod.api.qcloud.com/v2/index.php?Action=GetVideoInfo
&fileId=14508071098244959037
&COMMON_PARAMS

获取视频部分信息(基础信息和转码结果信息)

https://vod.api.qcloud.com/v2/index.php?Action=GetVideoInfo
&fileId=14508071098244959037
&infoFilter.0=basicInfo
&infoFilter.1=transcodeInfo
&COMMON_PARAMS

接口应答

参数说明

参数名称 类型 说明
code Integer 错误码, 0: 成功, 其他值: 失败
message String 错误信息
basicInfo Object 视频基础信息,字段信息参见 basicInfo(视频基础信息)
metaData Object 视频元信息,字段信息参见 metaData(视频元信息)
drm Object 文件加密信息,用户在发起任务流时在 转码控制参数 指定了加密,该字段才存在。 字段信息参见 drm(视频加密信息)
transcodeInfo Object 视频转码结果信息
animatedGraphicsInfo Object 转动图结果信息
sampleSnapshotInfo Array 采样截图信息
imageSpriteInfo Object 视频雪碧图信息
snapshotByTimeOffsetInfo Object 指定时间点截图信息
keyFrameDescInfo Object 视频关键帧描述(打点)信息

basicInfo(视频基础信息)

参数名称 类型 描述
name String 视频名称
size Integer 视频大小。单位:字节
duration Integer 视频时长。单位:秒
description String 视频描述
status String 视频状态, normal:正常
createTime Integer 视频创建时间(Unix 时间戳)
updateTime Integer 视频信息最近更新时间(Unix 时间戳)
expireTime Integer 视频过期时间(Unix 时间戳),视频过期之后,该视频及其所有附属对象(转码结果、雪碧图等)将都被删除
classificationId Integer 视频分类 ID
classificationName String 视频分类名称
playerId Integer 播放器 ID
coverUrl String 视频封面图片地址
type String 视频封装格式,例如 mp4 和 flv 等
sourceVideoUrl String 视频源文件地址

aiAnalysisInfo(智能分析结果信息)

参数名称 类型 描述
classificationList Array 智能分类结果列表,元素为 智能分类结果信息
tagList Array 智能标签结果列表,元素为 智能标签结果信息

classificationInfo(智能分类结果信息)

参数名称 类型 描述
definition Integer 智能分类模板 ID
classifications Array 分类结果数组
classifications.classification String 分类类别名称
classifications.confidence Float 分类的可信度

tagInfo(智能标签结果信息)

参数名称 类型 描述
definition Integer 智能标签模板 ID
tags Array 标签结果数组
tags.tag String 标签名称
tags.confidence Float 标签的可信度

contentReviewInfo(内容审核结果信息)

参数名称 类型 描述
pornList Array 鉴黄审核结果列表,元素为 鉴黄结果信息

pornInfo(鉴黄结果信息)

参数名称 类型 描述
definition Integer 鉴黄模板 ID
confidence Float 视频鉴黄评分,分值为0到100
suggestion String 鉴黄结果建议,有pass、review 和 block三种
segments Array 有涉黄嫌疑的视频片段
segments.startTimeOffset Float 嫌疑片段起始的偏移时间,单位秒
segments.endTimeOffset Float 嫌疑片段结束的偏移时间,单位秒
segments.confidence Float 嫌疑片段涉黄分数
segments.suggestion Float 嫌疑片段鉴黄结果建议,有 pass、review 和 block 三种
segments.url String 涉黄嫌疑图片 URL (图片不会永久存储,在一段时间后失效)
segments.picUrlExpireTimeStamp Integer 涉黄嫌疑图片 URL 失效时间(Unix 时间戳)

metaData(视频元信息)

参数名称 类型 描述
size Integer 视频大小。单位:字节
container String 容器类型,例如 m4a 和 mp4 等
bitrate Integer 视频流码率平均值与音频流码率平均值之和。 单位:bps
height Integer 视频流高度的最大值。单位:px
width Integer 视频流宽度的最大值。单位:px
md5 String 视频的md5值,目前暂不支持
duration Integer 视频时长。单位:秒
floatDuration Float Float表示的视频时长,更精确。单位:秒
rotate Integer 视频拍摄时的选择角度。单位:度
totalSize Integer 视频文件总大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和)。单位:字节
videoStreamList Array 视频流信息
videoStreamList.bitrate Integer 视频流的码率,单位:bps
videoStreamList.height Integer 视频流的高度,单位:px
videoStreamList.width Integer 视频流的宽度,单位:px
videoStreamList.codec String 视频流的编码格式,例如 h264
videoStreamList.fps Integer 帧率,单位:hz
audioStreamList Array 音频流信息
audioStreamList.bitrate Integer 音频流的码率。 单位:bps
audioStreamList.samplingRate Integer 音频流的采样率。 单位:hz
audioStreamList.codec String 音频流的编码格式,例如 aac

drm(视频加密信息)

参数名称 类型 描述
definition Integer 加密模板 ID
encryptType String 加密类型,目前只有 SingleKey 一种
keySource String KMS(密钥管理服务)的类型,总共三种,分别为 VodBuildInKMS:腾讯云点播内置 KMS;QCloudKMS:腾讯云 KMS 系统(暂不支持);PrivateKMS:用于自有 KMS 系统(暂不支持)
getKeyUrl String 获取解密密钥的URL
edkList Array 加密后的数据密钥列表

transcodeInfo(视频转码结果信息)

如果视频已经成功进行转码,则可以获取视频的转码结果信息;如果视频并未进行过转码,或者转码失败,则该视频不存在转码结果信息。

参数名称 类型 描述
idrAlignment Integer 转码的视频是否 IDR 对齐。0:不对齐;1对齐。
transcodeList Array 各规格的转码信息集合,每个元素代表一个规格的转码结果
transcodeList.url String 转码后的视频文件地址
transcodeList.definition Integer 参见 转码参数模板
transcodeList.bitrate Integer 视频流码率平均值与音频流码率平均值之和。 单位:bps
transcodeList.height Integer 视频流高度的最大值。单位:px
transcodeList.width Integer 视频流宽度的最大值。单位:px
transcodeList.size Integer 视频大小。单位:字节
transcodeList.duration Integer 视频时长。单位:秒
transcodeList.floatDuration Float Float 表示的视频时长,更精确。单位:秒
transcodeList.container String 容器类型,例如 m4a 和 mp4 等
transcodeList.md5 String 视频的 md5 值
transcodeList.audioStreamList Array 音频流信息,字段信息与元信息中 audioStreamList 相同
transcodeList.videoStreamList Array 视频流信息,字段信息与元信息中 videoStreamList 相同

animatedGraphicsInfo(视频转动图结果信息)

参数名称 类型 描述
animatedGraphicsList Array 各规格的转动图集合,每个元素代表一个规格的转码结果
animatedGraphicsList.url String 转动图的文件地址
animatedGraphicsList.definition Integer 参见 转动图参数模板
animatedGraphicsList.container String 动图格式,如 gif
animatedGraphicsList.height Integer 动图的高度。单位:px
animatedGraphicsList.width Integer 动图的宽度。单位:px
animatedGraphicsList.bitrate Integer 动图码率。单位:bps
animatedGraphicsList.size Integer 动图大小。单位:字节
animatedGraphicsList.md5 String 动图的 md5 值
animatedGraphicsList.startTime Integer 动图在视频中的起始时间。单位:秒
animatedGraphicsList.endTime Integer 动图在视频中的结束时间。单位:秒

sampleSnapshotInfo(采样截图信息)

参数名称 类型 描述
sampleSnapshotInfo.definition Integer 参见 采样截图参数模板
sampleSnapshotInfo.sampleType String 采样方式,Percent 为根据百分比间隔采样,Time 为根据时间间隔采样
sampleSnapshotInfo.interval String 若 type 为 Percent,表示多少百分比一张图; 若 type为Time,表示多少时间间隔一张图,单位秒。 第一张图均为视频首帧
sampleSnapshotInfo.imageUrls Array 字符串数组,生成的截图 url 列表
sampleSnapshotInfo.watermarkDefinition Array 整数数组,水印模板列表

imageSpriteInfo(视频雪碧图信息)

如果视频已经成功截取雪碧图,则可以获取视频的雪碧图信息;如果视频并未截取过雪碧图,或者截取雪碧图失败,则该视频不存在雪碧图信息。

参数名称 类型 描述
imageSpriteList Array 特定规格的雪碧图信息集合,每个元素代表一套相同规格的雪碧图
imageSpriteList.definition Integer 参见 雪碧图参数模板
imageSpriteList.height Integer 雪碧图小图的高度
imageSpriteList.width Integer 雪碧图小图的宽度
imageSpriteList.totalCount Integer 每一张雪碧图中小图的数量
imageSpriteList.imageUrls Array 每一张雪碧图的地址
imageSpriteList.webVttUrl String 雪碧图子图位置与时间关系 WebVtt 文件地址

snapshotByTimeOffsetInfo(视频指定时间点截图信息)

如果视频曾经指定时间点截图成功过,则可以获取视频的指定时间点截图信息;如果视频并未进行过指定时间点截图,则该视频不存在指定时间点截图信息。

参数名称 类型 描述
snapshotByTimeOffsetList Array 特定规格的指定时间点截图信息集合。目前每种规格只能有一套截图。
snapshotByTimeOffsetList.definition Integer 参见 指定时间点截图参数模板
snapshotByTimeOffsetList.picInfoList Array 同一规格的截图信息集合,每个元素代表一张截图
snapshotByTimeOffsetList.picInfoList.timeOffset Integer 该张截图对应视频文件中的时间偏移。单位:毫秒
snapshotByTimeOffsetList.picInfoList.url String 该张截图的地址,如果 status 非0,则 url 不存在
snapshotByTimeOffsetList.picInfoList.watermarkDefinition Array 整数数组,水印模板列表

keyFrameDescInfo(打点信息)

参数名称 类型 描述
keyFrameDescList Array 视频打点信息集合,每个元素代表一个打点,数组长度最大100
keyFrameDescList.timeOffset Integer 打点时间偏移,唯一标识一个打点。单位:毫秒
keyFrameDescList.content String 经过 URL Encoded 的打点文本描述信息。

错误码说明

错误码 含义说明
4000 - 7000 参见 公共错误码
1 内部错误
1000 无效参数
1001 内部错误
1003 内部错误
2000 内部错误
10008 文件不存在
10022 内部错误

应答示例

{
    "code": 0,
    "message": "",
    "basicInfo": {
        "name": "test file",
        "size": 1000,
        "duration": 10,
        "description": "",
        "status": "",
        "createTime": 1485156352,
        "updateTime": 1485156352,
        "expireTime": 1485256352,
        "classificationId": 1,
        "classificationName": "",
        "playerId": 0,
        "coverUrl": "http://xx.vod2.myqcloud.com/xxxxxxxx/shotup/f0.100_0.jpg",
        "type": "mp4",
        "sourceVideoUrl": "http://xx.vod2.myqcloud.com/xx/xx/f0.mp4"
    },
    "metaData": {
        "size": 10556,
        "container": "m4a",
        "md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
        "duration": 3601,
        "bitrate": 246035,
        "height": 480,
        "width": 640,
        "videoStreamList": [
            {
                "bitrate": 246000,
                "height": 480,
                "width": 640,
                "codec": "h264",
                "fps": 222
            }
        ],
        "audioStreamList": [
            {
                "codec": "aac",
                "samplingRate": 44100,
                "bitrate": 35
            }
        ]
    },
    "drm": {
        "definition": 10,
        "getKeyUrl": "https://123.xxx.com/getkey",
        "encryptType": "SingleKey",
        "keySource": "VodBuildInKMS",
        "edkList": [
            "232abc30"
        ]
    },
    "aiAnalysisInfo": {
        "classificationList": [
            {
                "definition": 10,
                "classifications": [
                    {
                        "classification": "军事",
                        "confidence": 98.7
                    },
                    {
                        "classification": "时政",
                        "confidence": 98.7
                    }
                ]
            }
        ],
        "tagList": [
            {
                "definition": 10,
                "tags": {
                    {
                        "tag": "武器",
                        "confidence": 98.7
                    },
                    {
                        "tag": "舰船",
                        "confidence": 98.5
                    },
                    {
                        "tag": "海洋",
                        "confidence": 88.5
                    }
                ]
            }
        ]
    },
    "contentReviewInfo" : {
        "pornList": [
            {
                "definition": 10,
                "confidence": 98.0,
                "suggestion": "block",
                "segments": [
                    {
                        "startTimeOffset": 20.0,
                        "endTimeOffset": 120.0,
                        "confidence": 98.0,
                        "suggestion": "block"
                        "url": "http://xxx.vod2.myqcluod.com/xxx/xxx/xx.jpg",
                        "picUrlExpireTimeStamp": 1530005146
                    },
                    {
                        "startTimeOffset": 120.0,
                        "endTimeOffset": 130.0,
                        "confidence": 54.0,
                        "suggestion": "review",
                        "url": "http://xxx.vod2.myqcluod.com/xxx/xxx/xx.jpg",
                        "picUrlExpireTimeStamp": 1530005146
                    }
                ],
            }
        ]
    },
    "transcodeInfo": {
        "idrAlignment": 1,
        "transcodeList": [
            {
                "url": "http://xxxx.vod2.myqcloud.com/xx/xx/f0.mp4",
                "definition": 0,
                "bitrate": 563477,
                "height": 378,
                "width": 672,
                "container": "m4a",
                "duration": 3601,
                "size": 10502,
                "md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
                "videoStreamList": [
                    {
                        "bitrate": 246000,
                        "height": 480,
                        "width": 640,
                        "codec": "h264",
                        "fps": 222
                    }
                ],
                "audioStreamList": [
                    {
                        "codec": "aac",
                        "samplingRate": 44100,
                        "bitrate": 35
                    }
                ]
            },
            {
                "url": "http://xxxx.vod2.myqcloud.com/xx/xx/f0.f210.m3u8",
                "definition": 211,
                "bitrate": 563477,
                "height": 378,
                "width": 672,
                "container": "mov",
                "duration": 3601,
                "size": 10502,
                "md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
                "videoStreamList": [
                    {
                        "bitrate": 246000,
                        "height": 480,
                        "width": 640,
                        "codec": "h264",
                        "fps": 222
                    }
                ],
                "audioStreamList": [
                    {
                        "codec": "aac",
                        "samplingRate": 44100,
                        "bitrate": 35
                    }
                ]
            },
            {
                "url": "http://xxxx.vod2.myqcloud.com/xx/xx/master_playlist.m3u8",
                "definition": 10000,
                "duration": 145,
                "size": 265,
                "bitrate": 2840055,
                "height": 1080,
                "width": 1920,
                "container": "hls,applehttp",
                "md5": "bfcf7c6f154b18890661f9e80b0731d0",
                "videoStreamList": [
                    {
                        "bitrate": 2794233,
                        "height": 1080,
                        "width": 1920,
                        "codec": "h264",
                        "fps": 24
                    }
                ],
                "audioStreamList": [
                    {
                        "samplingRate": 44100,
                        "bitrate": 45822,
                        "codec": "aac"
                    }
                ]
            }
        ]
    },
    "animatedGraphicsInfo": {
        "animatedGraphicsList": [
            {
               "url": "http://125xx.vod2.myqcloud.com/xx/xx/f20000.gif",
               "definition": 20000,
               "container": "gif",
               "height": 480,
               "width": 640,
               "bitrate": 1000000,
               "size": 600000,
               "md5": "bfcf7c6f154b1842a661f9e80b07a1d0",
               "startTime": 10,
               "endTime": 15
           }
        ]
    },
    "sampleSnapshotInfo": [
        {
            "definition": 10,
            "sampleType": "percent",
            "interval": 10,
            "imageUrls": [
                "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx1.png",
                ...,
                "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx9.png",
                "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx10.png"
            ]
        }
    ],
    "imageSpriteInfo": {
        "imageSpriteList": [
            {
                "definition": 10,
                "height": 576,
                "width": 1024,
                "totalCount": 100,
                "imageUrls": [
                    "http://xx.vod2.myqcloud.com/xx/xx/imageSprite/xx.100_0.jpg"
                ],
                "webVttUrl": "http://xx.vod2.myqcloud.com/xxxx/xxxx/imageSprite/xx.vtt"
            }
        ]
    },
    "snapshotByTimeOffsetInfo": {
        "snapshotByTimeOffsetList": [
            {
                "definition": 10,
                "picInfoList": [
                    {
                        "timeOffset": 0,
                        "url": "http://xxxx.vod2.myqcloud.com/xx/xx/snapshotByTime/xx1.jpg"
                    },
                    {
                        "timeOffset": 1000,
                        "url": "http://xxxx.vod2.myqcloud.com/xx/xx/snapshotByTime/xx2.jpg"
                    }
                ]
            }
        ]
    },
    "keyFrameDescInfo": {
        "keyFrameDescList": [
            {
                "timeOffset": 1100,
                "content": "abc"
            },
            {
                "timeOffset": 100200,
                "content": "def"
            }
        ]
    }
}