获取媒体详细信息

最近更新时间:2019-05-30 20:49:35

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

  1. 该接口可以获取多个视频的多种信息,包括:
    1. 基础信息(basicInfo):包括视频名称、大小、时长、封面图片等。
    2. 元信息(metaData):包括视频流信息、音频流信息等。
    3. 转码结果信息(transcodeInfo):包括该视频转码生成的各种码率的视频的地址、规格、码率、分辨率等。
    4. 转动图结果信息(animatedGraphicsInfo):对视频转动图(如 gif)后,动图相关信息。
    5. 采样截图信息(sampleSnapshotInfo):对视频采样截图后,相关截图信息。
    6. 雪碧图信息(imageSpriteInfo):对视频截取雪碧图之后,雪碧图的相关信息。
    7. 指定时间点截图信息(snapshotByTimeOffsetInfo):对视频依照指定时间点截图后,各个截图的信息。
    8. 视频打点信息(keyFrameDescInfo):对视频设置的各个打点信息。
    9. 转自适应码流信息(adaptiveDynamicStreamingInfo):包括规格、加密类型、打包格式等相关信息。
  2. 可以指定回包只返回部分信息。

默认接口请求频率限制:100次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMediaInfos
Version String 公共参数,本接口取值:2018-07-17
Region String 公共参数,本接口不需要传递此参数。
FileIds.N Array of String 媒体文件 ID 列表,N 从 0 开始取值,最大 19。
Filters.N Array of String 指定所有媒体文件需要返回的信息,可同时指定多个信息,N 从 0 开始递增。如果未填写该字段,默认返回所有信息。选项有:
  • basicInfo(视频基础信息)。
  • metaData(视频元信息)。
  • transcodeInfo(视频转码结果信息)。
  • animatedGraphicsInfo(视频转动图结果信息)。
  • imageSpriteInfo(视频雪碧图信息)。
  • snapshotByTimeOffsetInfo(视频指定时间点截图信息)。
  • sampleSnapshotInfo(采样截图信息)。
  • keyFrameDescInfo(打点信息)。
  • adaptiveDynamicStreamingInfo(转自适应码流信息)。
  • SubAppId Integer 点播子应用 ID 。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

    3. 输出参数

    参数名称 类型 描述
    MediaInfoSet Array of MediaInfo 媒体文件信息列表。
    注意:此字段可能返回 null,表示取不到有效值。
    NotExistFileIdSet Array of String 不存在的文件 ID 列表。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取媒体详细信息成功

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeMediaInfos
    &FileIds.0=5285485487985271487
    &FileIds.1=5285485487985271488
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
        "MediaInfoSet": [
          {
            "FileId": "5285485487985271487",
            "BasicInfo": {
              "Name": "test file",
              "Description": "",
              "CreateTime": "2017-01-23T07:25:52Z",
              "UpdateTime": "2017-01-23T07:25:52Z",
              "ExpireTime": "2017-03-23T07:25:52Z",
              "ClassId": 1,
              "ClassName": "测试",
              "ClassPath": "测试",
              "CoverUrl": "http://xx.vod2.myqcloud.com/xxxxxxxx/shotup/f0.100_0.jpg",
              "Type": "mp4",
              "MediaUrl": "http://xx.vod2.myqcloud.com/xx/xx/f0.mp4",
              "TagSet": [],
              "SourceInfo": {
                "SourceType": "Record",
                "SourceContext": ""
              },
              "StorageRegion": "gzp"
            },
            "MetaData": {
              "Size": 10556,
              "Container": "m4a",
              "Duration": 3601.0,
              "Bitrate": 246035,
              "Height": 480,
              "Width": 640,
              "Rotate": 0,
              "VideoStreamSet": [
                {
                  "Bitrate": 246000,
                  "Height": 480,
                  "Width": 640,
                  "Codec": "h264",
                  "Fps": 222
                }
              ],
              "AudioStreamSet": [
                {
                  "Codec": "aac",
                  "SamplingRate": 44100,
                  "Bitrate": 35
                }
              ]
            },
            "TranscodeInfo": {
              "TranscodeSet": [
                {
                  "Url": "http://xxxx.vod2.myqcloud.com/xx/xx/f0.mp4",
                  "Definition": 0,
                  "Bitrate": 563477,
                  "Height": 378,
                  "Width": 672,
                  "Container": "m4a",
                  "Duration": 3601.0,
                  "Size": 10502,
                  "Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
                  "VideoStreamSet": [
                    {
                      "Bitrate": 246000,
                      "Height": 480,
                      "Width": 640,
                      "Codec": "h264",
                      "Fps": 222
                    }
                  ],
                  "AudioStreamSet": [
                    {
                      "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.0,
                  "Size": 10502,
                  "Md5": "b3ae6ed07d9bf4efeeb94ed2d37ff3e3",
                  "VideoStreamSet": [
                    {
                      "Bitrate": 246000,
                      "Height": 480,
                      "Width": 640,
                      "Codec": "h264",
                      "Fps": 222
                    }
                  ],
                  "AudioStreamSet": [
                    {
                      "Codec": "aac",
                      "SamplingRate": 44100,
                      "Bitrate": 35
                    }
                  ]
                },
                {
                  "Url": "http://xxxx.vod2.myqcloud.com/xx/xx/master_playlist.m3u8",
                  "Definition": 10000,
                  "Duration": 145.0,
                  "Size": 265,
                  "Bitrate": 2840055,
                  "Height": 1080,
                  "Width": 1920,
                  "Container": "hls,applehttp",
                  "Md5": "bfcf7c6f154b18890661f9e80b0731d0",
                  "VideoStreamSet": [
                    {
                      "Bitrate": 2794233,
                      "Height": 1080,
                      "Width": 1920,
                      "Codec": "h264",
                      "Fps": 24
                    }
                  ],
                  "AudioStreamSet": [
                    {
                      "SamplingRate": 44100,
                      "Bitrate": 45822,
                      "Codec": "aac"
                    }
                  ]
                }
              ]
            },
            "AnimatedGraphicsInfo": {
              "AnimatedGraphicsSet": [
                {
                  "Url": "http://125xx.vod2.myqcloud.com/xx/xx/f20000.gif",
                  "Definition": 20000,
                  "Container": "gif",
                  "Height": 480,
                  "Width": 640,
                  "Bitrate": 1000000,
                  "Size": 600000,
                  "Md5": "bfcf7c6f154b1842a661f9e80b07a1d0",
                  "StartTimeOffset": 10.0,
                  "EndTimeOffset": 15.0
                }
              ]
            },
            "SampleSnapshotInfo": {
              "SampleSnapshotSet": [
                {
                  "Definition": 10,
                  "SampleType": "percent",
                  "Interval": 10,
                  "ImageUrlSet": [
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx1.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx2.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx3.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx4.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx5.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx6.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx7.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx8.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx9.png",
                    "http://125xx.vod2.myqcloud.com/xx/xx/shotup/xx10.png"
                  ]
                }
              ]
            },
            "ImageSpriteInfo": {
              "ImageSpriteSet": [
                {
                  "Definition": 10,
                  "Height": 576,
                  "Width": 1024,
                  "TotalCount": 100,
                  "ImageUrlSet": [
                    "http://xx.vod2.myqcloud.com/xx/xx/imageSprite/xx.100_0.jpg"
                  ],
                  "WebVttUrl": "http://xx.vod2.myqcloud.com/xxxx/xxxx/imageSprite/xx.vtt"
                }
              ]
            },
            "SnapshotByTimeOffsetInfo": {
              "SnapshotByTimeOffsetSet": [
                {
                  "Definition": 10,
                  "PicInfoSet": [
                    {
                      "TimeOffset": 0.0,
                      "Url": "http://xxxx.vod2.myqcloud.com/xx/xx/snapshotByTime/xx1.jpg"
                    },
                    {
                      "TimeOffset": 1000.0,
                      "Url": "http://xxxx.vod2.myqcloud.com/xx/xx/snapshotByTime/xx2.jpg"
                    }
                  ]
                }
              ]
            },
            "KeyFrameDescInfo": {
              "KeyFrameDescSet": [
                {
                  "TimeOffset": 1.0,
                  "Content": "abc"
                },
                {
                  "TimeOffset": 100.0,
                  "Content": "def"
                }
              ]
            }
          }
        ]
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameterValue.FileIds FileIds 参数错误。