Skip to content

VideoProperties

Source code in docs_src/capo_mediaconvert/types/video_properties.py
class VideoProperties(TypedDict, closed=True):
    bit_depth: NotRequired["capo_mediaconvert.types.__integer.__integer"]
    """The number of bits used per color component such as 8, 10, or 12 bits. Standard range (SDR) video typically uses 8-bit, while 10-bit is common for high dynamic range (HDR)."""
    bit_rate: NotRequired["capo_mediaconvert.types.__long.__long"]
    """The bit rate of the video track, in bits per second."""
    codec_metadata: NotRequired["capo_mediaconvert.types.codec_metadata.CodecMetadata"]
    """Codec-specific parameters parsed from the video essence headers. This information provides detailed technical specifications about how the video was encoded, including profile settings, resolution details, and color space information that can help you understand the source video characteristics and make informed encoding decisions. These fields are returned for H.264 (AVC), H.265 (HEVC), and MPEG-2 video, and might not be returned for other codecs. For MPEG-TS and MPEG-PS inputs, color information (color primaries, transfer characteristics, and matrix coefficients) appears in these fields rather than in the top-level videoProperties."""
    color_primaries: NotRequired[
        "capo_mediaconvert.types.color_primaries.ColorPrimaries"
    ]
    """The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding."""
    display_aspect_ratio: NotRequired[
        "capo_mediaconvert.types.aspect_ratio.AspectRatio"
    ]
    """An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use."""
    frame_rate: NotRequired["capo_mediaconvert.types.frame_rate.FrameRate"]
    """The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values."""
    hdr_metadata: NotRequired["capo_mediaconvert.types.hdr_metadata.HdrMetadata"]
    """HDR (High Dynamic Range) metadata extracted from the container, including mastering display color volume and content light level information. This metadata is present in HDR10 and similar HDR content."""
    height: NotRequired["capo_mediaconvert.types.__integer.__integer"]
    """The height of the video track, in pixels."""
    matrix_coefficients: NotRequired[
        "capo_mediaconvert.types.matrix_coefficients.MatrixCoefficients"
    ]
    """The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes."""
    rotation: NotRequired["capo_mediaconvert.types.__integer.__integer"]
    """The clockwise rotation angle of the video track, in degrees, as derived from container-level metadata (e.g. the MP4 tkhd transformation matrix or the Matroska ProjectionPoseRoll element). Common values are 90, 180, and 270. This field is null when no rotation metadata is present or when the rotation is 0 degrees. For MP4, non-standard transformation matrices also yield null."""
    sample_aspect_ratio: NotRequired["capo_mediaconvert.types.aspect_ratio.AspectRatio"]
    """An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use."""
    transfer_characteristics: NotRequired[
        "capo_mediaconvert.types.transfer_characteristics.TransferCharacteristics"
    ]
    """The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction."""
    width: NotRequired["capo_mediaconvert.types.__integer.__integer"]
    """The width of the video track, in pixels."""

bit_depth instance-attribute

bit_depth: NotRequired[__integer]

The number of bits used per color component such as 8, 10, or 12 bits. Standard range (SDR) video typically uses 8-bit, while 10-bit is common for high dynamic range (HDR).

bit_rate instance-attribute

bit_rate: NotRequired[__long]

The bit rate of the video track, in bits per second.

codec_metadata instance-attribute

codec_metadata: NotRequired[CodecMetadata]

Codec-specific parameters parsed from the video essence headers. This information provides detailed technical specifications about how the video was encoded, including profile settings, resolution details, and color space information that can help you understand the source video characteristics and make informed encoding decisions. These fields are returned for H.264 (AVC), H.265 (HEVC), and MPEG-2 video, and might not be returned for other codecs. For MPEG-TS and MPEG-PS inputs, color information (color primaries, transfer characteristics, and matrix coefficients) appears in these fields rather than in the top-level videoProperties.

color_primaries instance-attribute

color_primaries: NotRequired[ColorPrimaries]

The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.

display_aspect_ratio instance-attribute

display_aspect_ratio: NotRequired[AspectRatio]

An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use.

frame_rate instance-attribute

frame_rate: NotRequired[FrameRate]

The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values.

hdr_metadata instance-attribute

hdr_metadata: NotRequired[HdrMetadata]

HDR (High Dynamic Range) metadata extracted from the container, including mastering display color volume and content light level information. This metadata is present in HDR10 and similar HDR content.

height instance-attribute

height: NotRequired[__integer]

The height of the video track, in pixels.

matrix_coefficients instance-attribute

matrix_coefficients: NotRequired[MatrixCoefficients]

The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.

rotation instance-attribute

rotation: NotRequired[__integer]

The clockwise rotation angle of the video track, in degrees, as derived from container-level metadata (e.g. the MP4 tkhd transformation matrix or the Matroska ProjectionPoseRoll element). Common values are 90, 180, and 270. This field is null when no rotation metadata is present or when the rotation is 0 degrees. For MP4, non-standard transformation matrices also yield null.

sample_aspect_ratio instance-attribute

sample_aspect_ratio: NotRequired[AspectRatio]

An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use.

transfer_characteristics instance-attribute

transfer_characteristics: NotRequired[TransferCharacteristics]

The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.

width instance-attribute

width: NotRequired[__integer]

The width of the video track, in pixels.