Probe - AWS Elemental MediaConvert API Reference

URI HTTP methods Schemas Properties See also

Probe

URI

/2017-08-29/probe

HTTP methods

POST

Operation ID: Probe

Use Probe to obtain detailed information about your input media files. Probe returns a JSON that includes container, codec, frame rate, resolution, track count, audio layout, captions, and more. You can use this information to learn more about your media files, or to help make decisions while automating your transcoding workflow.

Responses
Status code	Response model	Description
`200`	`ProbeResponse`	200 response
`400`	`ExceptionBody`	The service can't process your request because of a problem in the request. Please check your request form and syntax.
`403`	`ExceptionBody`	You don't have permissions for this action with the credentials you sent.
`404`	`ExceptionBody`	The resource you requested does not exist.
`409`	`ExceptionBody`	The service could not complete your request because there is a conflict with the current state of the resource.
`429`	`ExceptionBody`	Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.
`500`	`ExceptionBody`	The service encountered an unexpected condition and cannot fulfill your request.

OPTIONS

Supports CORS preflight requests.

Responses
Status code	Response model	Description
`200`	None	The request completed successfully.

Schemas

Request bodies


{
  "inputFiles": [
    {
      "fileUrl": "string"
    }
  ]
}

POST schema


{
  "inputFiles": [
    {
      "fileUrl": "string"
    }
  ]
}

Response bodies


{
  "probeResults": [
    {
      "metadata": {
        "fileSize": integer,
        "eTag": "string",
        "lastModified": "string",
        "mimeType": "string"
      },
      "container": {
        "format": enum,
        "duration": number,
        "tracks": [
          {
            "index": integer,
            "codec": enum,
            "duration": number,
            "trackType": enum,
            "videoProperties": {
              "frameRate": {
                "numerator": integer,
                "denominator": integer
              },
              "width": integer,
              "height": integer,
              "bitDepth": integer,
              "bitRate": integer,
              "colorPrimaries": enum,
              "matrixCoefficients": enum,
              "transferCharacteristics": enum
            },
            "audioProperties": {
              "frameRate": {
                "numerator": integer,
                "denominator": integer
              },
              "sampleRate": integer,
              "channels": integer,
              "languageCode": "string",
              "bitDepth": integer,
              "bitRate": integer
            },
            "dataProperties": {
              "languageCode": "string"
            }
          }
        ]
      },
      "trackMappings": [
        {
          "videoTrackIndexes": [
            integer
          ],
          "audioTrackIndexes": [
            integer
          ],
          "dataTrackIndexes": [
            integer
          ]
        }
      ]
    }
  ]
}

ProbeResponse schema


{
  "probeResults": [
    {
      "metadata": {
        "fileSize": integer,
        "eTag": "string",
        "lastModified": "string",
        "mimeType": "string"
      },
      "container": {
        "format": enum,
        "duration": number,
        "tracks": [
          {
            "index": integer,
            "codec": enum,
            "duration": number,
            "trackType": enum,
            "videoProperties": {
              "frameRate": {
                "numerator": integer,
                "denominator": integer
              },
              "width": integer,
              "height": integer,
              "bitDepth": integer,
              "bitRate": integer,
              "colorPrimaries": enum,
              "matrixCoefficients": enum,
              "transferCharacteristics": enum
            },
            "audioProperties": {
              "frameRate": {
                "numerator": integer,
                "denominator": integer
              },
              "sampleRate": integer,
              "channels": integer,
              "languageCode": "string",
              "bitDepth": integer,
              "bitRate": integer
            },
            "dataProperties": {
              "languageCode": "string"
            }
          }
        ]
      },
      "trackMappings": [
        {
          "videoTrackIndexes": [
            integer
          ],
          "audioTrackIndexes": [
            integer
          ],
          "dataTrackIndexes": [
            integer
          ]
        }
      ]
    }
  ]
}


{
  "message": "string"
}

ExceptionBody schema


{
  "message": "string"
}

Properties

AudioProperties

Details about the media file's audio track.

Property	Type	Required	Description
`bitDepth`	integer	False	The bit depth of the audio track.
`bitRate`	integer Format: int32	False	The bit rate of the audio track, in bits per second.
`channels`	integer	False	The number of audio channels in the audio track.
`frameRate`	FrameRate	False	The frame rate of the video or audio track.
`languageCode`	string	False	The language code of the audio track, in three character ISO 639-3 format.
`sampleRate`	integer	False	The sample rate of the audio track.

ColorPrimaries

The color space color primaries of the video track.

ITU_709
UNSPECIFIED
RESERVED
ITU_470M
ITU_470BG
SMPTE_170M
SMPTE_240M
GENERIC_FILM
ITU_2020
SMPTE_428_1
SMPTE_431_2
SMPTE_EG_432_1
IPT
SMPTE_2067XYZ
EBU_3213_E
LAST

Container

The container of your media file. This information helps you understand the overall structure and details of your media, including format, duration, and track layout.

Property Type Required Description

Property	Type	Required	Description
`duration`	number Format: double	False	The total duration of your media file, in seconds.
`format`	string Values: `mp4 \| quicktime \| matroska \| webm`	False	The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), or WebM. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize.
`tracks`	Array of type Track	False	Details about each track (video, audio, or data) in the media file.

duration

number

Format: double

False

The total duration of your media file, in seconds.

format

string

Values: mp4 | quicktime | matroska | webm

False

The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), or WebM. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize.

tracks

Array of type Track

False

Details about each track (video, audio, or data) in the media file.

DataProperties

Details about the media file's data track.

Property	Type	Required	Description
`languageCode`	string	False	The language code of the data track, in three character ISO 639-3 format.

ExceptionBody

Property	Type	Required	Description
`message`	string	False

FrameRate

The frame rate of the video or audio track.

Property	Type	Required	Description
`denominator`	integer	False	The denominator, or bottom number, in the fractional frame rate. For example, if your frame rate is 24000 / 1001 (23.976 frames per second), then the denominator would be 1001.
`numerator`	integer	False	The numerator, or top number, in the fractional frame rate. For example, if your frame rate is 24000 / 1001 (23.976 frames per second), then the numerator would be 24000.

MatrixCoefficients

The color space matrix coefficients of the video track.

RGB
ITU_709
UNSPECIFIED
RESERVED
FCC
ITU_470BG
SMPTE_170M
SMPTE_240M
YCgCo
ITU_2020_NCL
ITU_2020_CL
SMPTE_2085
CD_NCL
CD_CL
ITU_2100ICtCp
IPT
EBU3213
LAST

Metadata

Metadata and other file information.

Property	Type	Required	Description
`eTag`	string	False	The entity tag (ETag) of the file.
`fileSize`	integer Format: int64	False	The size of the media file, in bytes.
`lastModified`	string Format: date-time	False	The last modification timestamp of the media file, in Unix time.
`mimeType`	string	False	The MIME type of the media file.

ProbeInputFile

The input file that needs to be analyzed.

Property	Type	Required	Description
`fileUrl`	string	False	Specify the S3, HTTP, or HTTPS URL for your media file.

ProbeRequest

The request to probe one or more media files and retrieve metadata about them.

Property	Type	Required	Description
`inputFiles`	Array of type ProbeInputFile	False	Specify a media file to probe.

ProbeResponse

The response from a MediaConvert Probe operation, in JSON form, with detailed information about your input media.

Property	Type	Required	Description
`probeResults`	Array of type ProbeResult	False	Probe results for your media file.

ProbeResult

Probe results for your media file.

Property	Type	Required	Description
`container`	Container	False	The container of your media file. This information helps you understand the overall structure and details of your media, including format, duration, and track layout.
`metadata`	Metadata	False	Metadata and other file information.
`trackMappings`	Array of type TrackMapping	False	An array containing track mapping information.

Track

Details about each track (video, audio, or data) in the media file.

Property	Type	Required	Description
`audioProperties`	AudioProperties	False	Details about the media file's audio track.
`codec`	string Values: `UNKNOWN \| AAC \| AC3 \| EAC3 \| FLAC \| MP3 \| OPUS \| PCM \| VORBIS \| AV1 \| AVC \| HEVC \| MJPEG \| MP4V \| MPEG2 \| PRORES \| THEORA \| VP8 \| VP9 \| C608 \| C708 \| WEBVTT`	False	The codec of the audio or video track, or caption format of the data track.
`dataProperties`	DataProperties	False	Details about the media file's data track.
`duration`	number Format: double	False	The duration of the track, in seconds.
`index`	integer	False	The unique index number of the track, starting at 1.
`trackType`	string Values: `video \| audio \| data`	False	The type of track: video, audio, or data.
`videoProperties`	VideoProperties	False	Details about the media file's video track.

TrackMapping

An array containing track mapping information.

Property	Type	Required	Description
`audioTrackIndexes`	Array of type integer	False	The index numbers of the audio tracks in your media file.
`dataTrackIndexes`	Array of type integer	False	The index numbers of the data tracks in your media file.
`videoTrackIndexes`	Array of type integer	False	The index numbers of the video tracks in your media file.

TransferCharacteristics

The color space transfer characteristics of the video track.

ITU_709
UNSPECIFIED
RESERVED
ITU_470M
ITU_470BG
SMPTE_170M
SMPTE_240M
LINEAR
LOG10_2
LOC10_2_5
IEC_61966_2_4
ITU_1361
IEC_61966_2_1
ITU_2020_10bit
ITU_2020_12bit
SMPTE_2084
SMPTE_428_1
ARIB_B67
LAST

VideoProperties

Details about the media file's video track.

Property	Type	Required	Description
`bitDepth`	integer	False	The bit depth of the video track.
`bitRate`	integer Format: int32	False	The bit rate of the video track, in bits per second.
`colorPrimaries`	ColorPrimaries	False	The color space color primaries of the video track.
`frameRate`	FrameRate	False	The frame rate of the video or audio track.
`height`	integer	False	The height of the video track, in pixels.
`matrixCoefficients`	MatrixCoefficients	False	The color space matrix coefficients of the video track.
`transferCharacteristics`	TransferCharacteristics	False	The color space transfer characteristics of the video track.
`width`	integer	False	The width of the video track, in pixels.

Select your cookie preferences

Probe

URI

HTTP methods

POST

OPTIONS

Schemas

Request bodies

POST schema

Response bodies

ProbeResponse schema

ExceptionBody schema

Properties

AudioProperties

ColorPrimaries

Container

DataProperties

ExceptionBody

FrameRate

MatrixCoefficients

Metadata

ProbeInputFile

ProbeRequest

ProbeResponse

ProbeResult

Track

TrackMapping

TransferCharacteristics

VideoProperties

See also

Probe

Did this page help you?

Next topic:

Previous topic:

Need help?