GetMezzanineInfo

Updated at:

Retrieves the source file information of an audio or video file, including the file URL, resolution, and bitrate.

Operation description

You can retrieve the complete source file information only after a video or audio stream is transcoded.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetMezzanineInfo

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

VideoId

string

No

The audio or video ID. You can obtain the ID by using one of the following methods:

  • For an audio or video file uploaded in the console, log on to the ApsaraVideo VOD console and choose Media Assets > Audio/Video to view the video ID.

  • When you call the Obtain the upload URL and credential for a video operation to obtain the upload URL and credential, the audio or video ID is the value of the VideoId response parameter.

  • After a video is uploaded, you can call the Search media information operation to query the audio or video ID, which is the value of the VideoId response parameter.

1f1a6fc03ca04814031b8a6559e****

AuthTimeout

integer

No

The expiration time of the signature for the FileURL (source file URL). Unit: seconds. Default value: 3600. Minimum value: 1.

  • If OutputType is set to cdn:
    • The FileURL expires periodically only if URL authentication is enabled. Otherwise, the FileURL is permanently valid.

    • Minimum value: 1.

    • Maximum value: unlimited.

    • Default value: 3600 if not specified.

  • If OutputType is set to oss:
    • The FileURL expires periodically only if the storage permission is set to private. Otherwise, the FileURL is permanently valid.

    • Minimum value: 1.

    • Maximum value: To reduce security risks of the origin server, the maximum value is 2592000 (30 days) when the audio or video file is stored in an ApsaraVideo VOD bucket, and 129600 (36 hours) when the audio or video file is stored in a user-owned OSS bucket.

    • Default value: 3600 if not specified.

3600

OutputType

string

No

The output URL type. Valid values:

  • oss: the back-to-origin URL.

  • cdn (default): the accelerated URL.

Note

If the bucket where the source file is stored is of the in type, only the OSS URL is returned.

oss

AdditionType

string

No

The type of additional information. Separate multiple values with commas (,). By default, only basic information is returned. Valid values:

  • video: the video stream information.

  • audio: the audio stream information.

video

ReferenceId

string

No

The custom ID. The ID must be 6 to 64 characters in length and can contain only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be unique per user.

123-123

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The request ID.

25818875-5F78-4AF6-D7393642CA58****

Mezzanine

object

The file information.

CreationTime

string

The time when the file was created. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-11-14T09:15:50Z

Status

string

The file status. Valid values:

  • Uploading: The file is being uploaded. This is the initial status of the file.

  • Normal: The file is uploaded.

  • UploadFail: The file fails to be uploaded.

  • Deleted: The file is deleted.

Normal

FileURL

string

The source file URL.

http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/27ffc438-164h67f57ef-0005-6884-51a-1****.mp4

VideoId

string

The video ID.

1f1a6fc03ca04814031b8a6559e****

Height

integer

The height of the file. Unit: pixels.

540

Bitrate

string

The bitrate of the file. Unit: Kbps.

771.2280

FileName

string

The file name.

27ffc438-164h67f57ef-0005-6884-51a-1****.mp4

OutputType

string

The output URL type. Valid values:

  • oss: the back-to-origin URL.

  • cdn (default): the accelerated URL.

Note

Only OSS URLs for MP4 playback are supported.

oss

PreprocessStatus

string

The preprocessing status. Valid values:

  • UnPreprocess: Not preprocessed.

  • Preprocessing: Being preprocessed.

  • PreprocessSucceed: Preprocessed.

  • PreprocessFailed: Preprocessing failed.

UnPreprocess

Width

integer

The width of the file. Unit: pixels.

960

Size

integer

The file size. Unit: bytes.

4096477

Duration

string

The file duration. Unit: seconds.

42.4930

Fps

string

The frame rate of the file, which indicates the number of frames per second.

25.0000

AudioStreamList

array<object>

The audio stream information.

object

The audio stream details.

Index

string

The sequence number of the audio stream, which identifies the position of the audio stream in the entire media stream.

0

Timebase

string

The time base.

0.000000

SampleFmt

string

The sampling format.

fltp

SampleRate

string

The sample rate.

44100

ChannelLayout

string

The channel layout. Valid values:

  • mono: mono.

  • stereo: stereo.

mono

Lang

string

The language.

und

CodecLongName

string

The long name of the codec format.

AAC (Advanced Audio Coding)

Channels

string

The number of sound channels.

1

NumFrames

string

The total number of frames.

1

Bitrate

string

The bitrate.

62.885

CodecTagString

string

The codec tag string.

mp4a

StartTime

string

The start time. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-01-11T12:00:00Z

CodecName

string

The short name of the codec format.

aac

Duration

string

The duration.

3.227574

CodecTag

string

The codec tag.

0x6134706d

CodecTimeBase

string

The codec time base.

1/44100

VideoStreamList

array<object>

The video stream information.

object

The video stream details.

Timebase

string

The time base.

0.000000

Index

string

The sequence number of the video stream, which identifies the position of the video stream in the entire media stream.

1

AvgFPS

string

The average frame rate.

30.0

PixFmt

string

The pixel format.

yuv420p

Lang

string

The language.

und

Sar

string

The sample aspect ratio.

0:1

Height

string

The height of the video.

320

CodecLongName

string

The long name of the codec format.

H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10

NumFrames

string

The total number of frames.

0

Bitrate

string

The bitrate of the file. Unit: Kbps.

500

Rotate

string

The video rotation angle. Valid values: [0, 360).

90

CodecTagString

string

The codec tag string.

avc1

HasBFrames

string

Indicates whether the video contains B-frames.

0

Profile

string

The codec profile.

Main

StartTime

string

The start time. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-01-11T12:00:00Z

Dar

string

The display aspect ratio.

0:1

CodecName

string

The short name of the codec format.

h264

Width

string

The width of the video.

568

Duration

string

The duration.

3.166667

Fps

string

The target frame rate.

30.0

CodecTag

string

The codec tag.

0x31637661

CodecTimeBase

string

The codec time base.

1/60

Level

string

The codec level.

30

HDRType

string

The HDR type of the video stream.

HDR

StorageClass

string

The media asset storage class. Valid values:

  • Standard: Standard.

  • IA: Infrequent Access for media assets.

  • Archive: Archive for media assets.

  • ColdArchive: Cold Archive for media assets.

  • SourceIA: Infrequent Access for source files.

  • SourceArchive: Archive for source files.

  • SourceColdArchive: Cold Archive for source files.

  • Changing: The storage class of the media asset is being changed.

  • SourceChanging: The storage class of the source file is being changed.

Standard

RestoreStatus

string

The media asset restoration status. Valid values:

  • Processing: Restoring.

  • Success: Restored.

  • Failed: Restoration failed.

Success

RestoreExpiration

string

The expiration time of the media asset restoration.

2023-03-30T10:14:14Z

FileMD5

string

The MD5 hash of the source file.

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Mezzanine": {
    "CreationTime": "2017-11-14T09:15:50Z",
    "Status": "Normal",
    "FileURL": "http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/27ffc438-164h67f57ef-0005-6884-51a-1****.mp4",
    "VideoId": "1f1a6fc03ca04814031b8a6559e****",
    "Height": 540,
    "Bitrate": "771.2280",
    "FileName": "27ffc438-164h67f57ef-0005-6884-51a-1****.mp4",
    "OutputType": "oss",
    "PreprocessStatus": "UnPreprocess",
    "Width": 960,
    "Size": 4096477,
    "Duration": "42.4930",
    "Fps": "25.0000",
    "AudioStreamList": [
      {
        "Index": "0",
        "Timebase": "0.000000",
        "SampleFmt": "fltp",
        "SampleRate": "44100",
        "ChannelLayout": "mono",
        "Lang": "und",
        "CodecLongName": "AAC (Advanced Audio Coding)",
        "Channels": "1",
        "NumFrames": "1",
        "Bitrate": "62.885",
        "CodecTagString": "mp4a",
        "StartTime": "2017-01-11T12:00:00Z",
        "CodecName": "aac",
        "Duration": "3.227574",
        "CodecTag": "0x6134706d",
        "CodecTimeBase": "1/44100"
      }
    ],
    "VideoStreamList": [
      {
        "Timebase": "0.000000",
        "Index": "1",
        "AvgFPS": "30.0",
        "PixFmt": "yuv420p",
        "Lang": "und",
        "Sar": "0:1",
        "Height": "320",
        "CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
        "NumFrames": "0",
        "Bitrate": "500",
        "Rotate": "90",
        "CodecTagString": "avc1",
        "HasBFrames": "0",
        "Profile": "Main",
        "StartTime": "2017-01-11T12:00:00Z",
        "Dar": "0:1",
        "CodecName": "h264",
        "Width": "568",
        "Duration": "3.166667",
        "Fps": "30.0",
        "CodecTag": "0x31637661",
        "CodecTimeBase": "1/60",
        "Level": "30",
        "HDRType": "HDR"
      }
    ],
    "StorageClass": "Standard",
    "RestoreStatus": "Success",
    "RestoreExpiration": "2023-03-30T10:14:14Z",
    "FileMD5": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.