Class: Aws::MediaConvert::Types::CodecMetadata

Inherits:

Struct

Object
Struct
Aws::MediaConvert::Types::CodecMetadata

show all

Defined in:: gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bit_depth ⇒ Integer
The number of bits used per color component in the video essence such as 8, 10, or 12 bits.
#chroma_subsampling ⇒ String
The chroma subsampling format used in the video encoding, such as "4:2:0" or "4:4:4".
#coded_frame_rate ⇒ Types::FrameRate
The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values.
#color_primaries ⇒ String
The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video.
#content_light_level ⇒ Types::ContentLightLevel
Content light level information (CTA-861.3).
#display_aspect_ratio ⇒ Types::AspectRatio
An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms.
#dolby_vision ⇒ Types::DolbyVisionMetadata
Dolby Vision characteristics of the video track: the profile and level, and whether the RPU (dynamic metadata), base layer, and enhancement layer are present.
#field_order ⇒ String
The field order of interlaced video, which indicates whether the top or bottom field is displayed first.
#hdr_10_plus_presence ⇒ String
Indicates that HDR10+ (SMPTE ST 2094-40) dynamic metadata was detected in the HEVC bitstream.
#height ⇒ Integer
The height in pixels as coded by the codec.
#level ⇒ String
The codec level or tier that specifies the maximum processing requirements and capabilities.
#matrix_coefficients ⇒ String
The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space.
#profile ⇒ String
The codec profile used to encode the video.
#rotation ⇒ Integer
The clockwise rotation angle of the video, in degrees, as specified in the codec bitstream via a Display Orientation SEI message (payload type 47 for both H.264 and H.265).
#sample_aspect_ratio ⇒ Types::AspectRatio
An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms.
#scan_type ⇒ String
The scanning method specified in the video essence, indicating whether the video uses progressive or interlaced scanning.
#transfer_characteristics ⇒ String
The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values.
#width ⇒ Integer
The width in pixels as coded by the codec.

Instance Attribute Details

#bit_depth ⇒ `Integer`

The number of bits used per color component in the video essence 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).

Returns:

(Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#chroma_subsampling ⇒ `String`

The chroma subsampling format used in the video encoding, such as "4:2:0" or "4:4:4". This describes how color information is sampled relative to brightness information. Different subsampling ratios affect video quality and file size, with "4:4:4" providing the highest color fidelity and "4:2:0" being most common for standard video.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#coded_frame_rate ⇒ `Types::FrameRate`

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

Returns:

(Types::FrameRate)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#color_primaries ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#content_light_level ⇒ `Types::ContentLightLevel`

Content light level information (CTA-861.3). Describes the light level characteristics of the content.

Returns:

(Types::ContentLightLevel)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#display_aspect_ratio ⇒ `Types::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.

Returns:

(Types::AspectRatio)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#dolby_vision ⇒ `Types::DolbyVisionMetadata`

Dolby Vision characteristics of the video track: the profile and level, and whether the RPU (dynamic metadata), base layer, and enhancement layer are present. Use this to distinguish Dolby Vision content from standard HEVC and to choose your encoding or passthrough settings. Omitted when the content is not Dolby Vision.

Returns:

(Types::DolbyVisionMetadata)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#field_order ⇒ `String`

The field order of interlaced video, which indicates whether the top or bottom field is displayed first. Use this to select the correct deinterlacing behavior. One of "TopFieldFirst" or "BottomFieldFirst". This field is present only for interlaced video; it is omitted for progressive video and when the field order is not indicated by the source.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#hdr_10_plus_presence ⇒ `String`

Indicates that HDR10+ (SMPTE ST 2094-40) dynamic metadata was detected in the HEVC bitstream. Present only when detected.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#height ⇒ `Integer`

The height in pixels as coded by the codec. This represents the actual encoded video height as specified in the video stream headers.

Returns:

(Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#level ⇒ `String`

The codec level or tier that specifies the maximum processing requirements and capabilities. Levels define constraints such as maximum bit rate, frame rate, and resolution.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#matrix_coefficients ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#profile ⇒ `String`

The codec profile used to encode the video. Profiles define specific feature sets and capabilities within a codec standard. For example, H.264 profiles include Baseline, Main, and High, each supporting different encoding features and complexity levels.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#rotation ⇒ `Integer`

The clockwise rotation angle of the video, in degrees, as specified in the codec bitstream via a Display Orientation SEI message (payload type 47 for both H.264 and H.265). This field is null when the video essence does not contain a Display Orientation SEI message or when the rotation is 0 degrees.

Returns:

(Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#sample_aspect_ratio ⇒ `Types::AspectRatio`

Returns:

(Types::AspectRatio)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#scan_type ⇒ `String`

The scanning method specified in the video essence, indicating whether the video uses progressive or interlaced scanning.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#transfer_characteristics ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#width ⇒ `Integer`

The width in pixels as coded by the codec. This represents the actual encoded video width as specified in the video stream headers.

Returns:

(Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 3411

class CodecMetadata < Struct.new(
  :bit_depth,
  :chroma_subsampling,
  :coded_frame_rate,
  :color_primaries,
  :content_light_level,
  :display_aspect_ratio,
  :dolby_vision,
  :field_order,
  :hdr_10_plus_presence,
  :height,
  :level,
  :matrix_coefficients,
  :profile,
  :rotation,
  :sample_aspect_ratio,
  :scan_type,
  :transfer_characteristics,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::MediaConvert::Types::CodecMetadata

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bit_depth ⇒ Integer

#chroma_subsampling ⇒ String

#coded_frame_rate ⇒ Types::FrameRate

#color_primaries ⇒ String

#content_light_level ⇒ Types::ContentLightLevel

#display_aspect_ratio ⇒ Types::AspectRatio

#dolby_vision ⇒ Types::DolbyVisionMetadata

#field_order ⇒ String

#hdr_10_plus_presence ⇒ String

#height ⇒ Integer

#level ⇒ String

#matrix_coefficients ⇒ String

#profile ⇒ String

#rotation ⇒ Integer

#sample_aspect_ratio ⇒ Types::AspectRatio

#scan_type ⇒ String

#transfer_characteristics ⇒ String

#width ⇒ Integer

#bit_depth ⇒ `Integer`

#chroma_subsampling ⇒ `String`

#coded_frame_rate ⇒ `Types::FrameRate`

#color_primaries ⇒ `String`

#content_light_level ⇒ `Types::ContentLightLevel`

#display_aspect_ratio ⇒ `Types::AspectRatio`

#dolby_vision ⇒ `Types::DolbyVisionMetadata`

#field_order ⇒ `String`

#hdr_10_plus_presence ⇒ `String`

#height ⇒ `Integer`

#level ⇒ `String`

#matrix_coefficients ⇒ `String`

#profile ⇒ `String`

#rotation ⇒ `Integer`

#sample_aspect_ratio ⇒ `Types::AspectRatio`

#scan_type ⇒ `String`

#transfer_characteristics ⇒ `String`

#width ⇒ `Integer`