获取媒资信息--视频点播-火山引擎

文档中心

立即注册

导航

获取媒资信息

最近更新时间：2024.10.08 11:42:00首次发布时间：2024.04.28 14:22:47

此接口用于通过 Vid（视频 ID）获取媒资信息，包含基础信息、片源信息及媒体处理输出文件信息。

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetMediaInfos&Version=2023-07-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetMediaInfos`	接口名称。当前 API 的名称为 `GetMediaInfos`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
Vids	String	是	`v02b69g10000***eldb8vjafvmg`	视频 ID 列表。多个 Vid 组成的字符串用 `,` 隔开。单次最多支持 20 个。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
MediaInfoList	Object[]	`-`	音视频信息列表。
BasicInfo	Object	`-`	音视频基础信息。
SpaceName	String	`vod-v2-test`	点播空间名称。
Vid	String	`v02b69g10000***eldb8vjafvmg`	音视频 ID。
Title	String	`视频`	音视频名称。
Description	String	`视频测试`	音视频描述。
PosterUri	String	`tos-cn-v-febf3a/9******783b00c8beb40724dee`	封面图对象存储地址。
PublishStatus	String	`Unpublished`	发布状态，取值如下： `Published`：发布。 `Unpublished`：未发布。
Tags	String[]	`[]`	音视频标签列表。
Classification	Object	`-`	音视频分类信息。
SpaceName	String	`test`	点播空间名称。
ClassificationId	Long	`1643`	分类 ID。
Level	Integer	`1`	分类级别： `1`：一级分类 `2`：二级分类 `3`：三级分类
Classification	String	`01`	分类名称。
ParentClassificationId	Long	`1345`	父分类 ID。
SubClassification	Object	`-`	子分类信息。
SubClassificationTrees	Object[]	`-`	子分类列表。
CreatedAt	String	`2022-02-18T15:08:07+08:00`	创建时间。
CreateTime	String	`2022-12-28T08:57:58Z`	音视频创建时间。
TosStorageClass	String	`STANDARD`	视频存储类型。取值如下： `STANDARD`：标准存储。 `ARCHIVE`：归档存储。 `IA`：低频存储。
VodUploadSource	String	`upload`	音视频来源。多个来源用 `,` 英文逗号分隔。取值如下： `upload`：上传 `live`：直播录制 `rtc`：RTC 录制 `url_upload`：URL 批量上传 `media_process`：视频处理 `media_edit`：视频剪辑
HlsMediaSize	Double	`0`	HlS 视频总和大小。HLS 视频协议包含 M3U8 和 TS 文件。
ExpireTime	String	`2024-08-30T20:10:11+08:00`	音视频文件过期时间。过期后该 Vid 对应的音视频文件及其相关资源（转码产物、封面图等）将被永久删除。采用 ISO 日期格式。`9999-12-31T23:59:59Z` 表示永不过期。注意亚太东南（柔佛）地域暂不支持此参数。
SourceInfo	Object	`-`	片源信息。
FileId	String	`v02b69g10***ldb8vjafvmg`	文件 ID。
Md5	String	`b9fd116504b***88e59a824878f07a`	文件 MD5 值。
FileType	String	`video`	文件类型。取值如下： `video`：视频。 `audio`：音频。
Codec	String	`h264`	编码格式。
Height	Integer	`270`	视频高度，单位为 px。
Width	Integer	`480`	视频宽度，单位为 px。
Format	String	`MP4`	文件格式。
Duration	Float	`2.944`	视频时长，单位为秒。
Size	Double	`104847`	文件大小，单位为字节。
StoreUri	String	`tos-cn-v-febf3a/daeba******a18e61e1aebfaf39aa.mp4`	对象存储地址。
Definition	String	`unknown`	清晰度。
Bitrate	Integer	`284910`	码率，单位为 bps。
Fps	Float	`25`	帧率，单位为 fps。
CreateTime	String	`2022-12-28T08:57:58Z`	创建时间。
Quality	String	`higher`	音频质量。
DynamicRange	String	`SDR`	动态范围。取值如下： `HDR` `SDR`
TosStorageClass	String	`STANDARD`	视频存储类型。取值如下： `STANDARD`：标准存储。 `ARCHIVE`：归档存储。 `IA`：低频存储。
FileName	String	`088ecee226***29d3e906c6.mp4`	文件路径。说明此字段暂时无法使用。
FileExtra	JSONMap	`-`	附加属性。
AudioStreamMeta	Object	`-`	音频流元信息。
Codec	String	`aac`	音频编码格式。
Duration	Float	`2.943`	音频时长，单位为秒。
SampleRate	Integer	`44100`	音频采样率，单位为 Hz。
Bitrate	Integer	`127658`	音频码率，单位为 bps。
Quality	String	`higher`	音频质量，取值如下： `medium`：普通音质 `higher`：高音质 `highest`：音乐音质
Channels	Integer	`2`	声道数。
VideoStreamMeta	Object	`-`	视频流元信息。
Codec	String	`h264`	视频编码格式。
Height	Integer	`270`	视频高度，单位为 px。
Width	Integer	`480`	视频宽度，单位为 px。
Duration	Float	`2.944`	视频时长，单位为秒。
Definition	String	`720p`	视频清晰度。
Bitrate	Integer	`284910`	视频码率，单位为 bps。
Fps	Float	`25`	视频帧率，单位为 fps。
TranscodeInfos	Object[]	`-`	转码产物信息列表。
FileId	String	`v020c9g10001***hs1v0go2sgujq0`	文件 ID。
Md5	String	`dd9fd3ad7f99f***ce70609aec68589`	文件 MD5 值。
FileType	String	`video`	文件类型。取值如下： `video`：视频。 `audio`：音频。
LogoType	String	`a`	Logo 类型。
Encrypt	Boolean	`false`	是否加密。
Format	String	`mp3`	文件格式。
Duration	Float	`2.944`	时长，单位为秒。
Size	Double	`104847`	文件大小，单位为字节。
StoreUri	String	`tos-cn-v/34fdg***58sd.mp4`	对象存储地址。
VideoStreamMeta	Object	`-`	视频流元信息。
Codec	String	`h264`	视频编码格式。
Height	Integer	`270`	视频高度，单位为 px。
Width	Integer	`480`	视频宽度，单位为 px。
Duration	Float	`2.944`	视频时长，单位为秒。
Definition	String	`720p`	视频清晰度。
Bitrate	Integer	`284910`	视频码率，单位为 bps。
Fps	Float	`25`	视频帧率，单位为 fps。
AudioStreamMeta	Object	`-`	音频流元信息。
Codec	String	`aac`	音频编码格式。
Duration	Float	`2.943`	音频时长，单位为秒。
SampleRate	Integer	`44100`	音频采样率，单位为 Hz。
Bitrate	Integer	`127658`	音频码率，单位为 bps。
Quality	String	`higher`	音频质量，取值如下： `medium`：普通音质 `higher`：高音质 `highest`：音乐音质
Channels	Integer	`2`	声道数。
CreateTime	String	`2021-04-02T02:47:33Z`	创建时间。
DynamicRange	String	`HDR`	动态范围。
TosStorageClass	String	`STANDARD`	视频存储类型。取值如下： `STANDARD`：标准存储； `ARCHIVE`：归档存储。 `IA`：低频存储。
FileExtra	JSONMap	`-`	附加属性。
NotExistVids	String[]	`["v0dc24g10001cm***s1v0lve1gj96g"]`	不存在的视频 `Vid` 列表。

请求示例

https://vod.volcengineapi.com?Action=GetMediaInfos&Version=2023-07-01

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20221228165***8DFF635830F5C63D",
    "Action": "GetMediaInfos",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "MediaInfoList": [
      {
        "BasicInfo": {
          "SpaceName": "vod-v2-test",
          "Vid": "v02b69g10000***eldb8vjafvmg",
          "Title": "",
          "Description": "",
          "PosterUri": "tos-cn-v-febf3a/9******783b00c8beb40724dee",
          "PublishStatus": "Unpublished",
          "Tags": [],
          "CreateTime": "2022-12-28T08:57:58Z",
          "Classification": null,
          "TosStorageClass": "STANDARD"
        },
        "SourceInfo": {
          "FileId": "v02b69g10***ldb8vjafvmg",
          "Md5": "b9fd116504b***88e59a824878f07a",
          "FileType": "video",
          "Codec": "h264",
          "Height": 270,
          "Width": 480,
          "Format": "MP4",
          "Duration": 2.944,
          "Size": 104847,
          "StoreUri": "tos-cn-v-febf3a/daeba******a18e61e1aebfaf39aa.mp4",
          "Definition": "unknown",
          "Bitrate": 284910,
          "Fps": 25,
          "CreateTime": "2022-12-28T08:57:58Z",
          "Quality": "",
          "DynamicRange": "SDR",
          "VideoStreamMeta": {
            "Codec": "h264",
            "Height": 270,
            "Width": 480,
            "Duration": 2.944,
            "Definition": "unknown",
            "Bitrate": 284910,
            "Fps": 25
          },
          "AudioStreamMeta": {
            "Codec": "",
            "Duration": 2.943,
            "SampleRate": 44100,
            "Bitrate": 127658,
            "Quality": ""
          },
          "TosStorageClass": "STANDARD"
        },
        "TranscodeInfos": []
      }
    ],
    "NotExistVids": []
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码	错误码	错误信息	说明
400	ItemLimitExceeded	-	请求参数包含的 Vid 数量超过 20。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：