mediaconvert/aws.sdk.kotlin.services.mediaconvert.model/CodecMetadata/Builder

Builder

Properties

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).

chromaSubsampling

var chromaSubsampling: 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.

codedFrameRate

var codedFrameRate: FrameRate?

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

colorPrimaries

var colorPrimaries: 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.

contentLightLevel

var contentLightLevel: ContentLightLevel?

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

displayAspectRatio

var displayAspectRatio: 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.

dolbyVision

var dolbyVision: 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.

fieldOrder

var fieldOrder: 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.

hdr10PlusPresence

var hdr10PlusPresence: Hdr10PlusPresence?

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

height

var height: Int?

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

level

var 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.

matrixCoefficients

var matrixCoefficients: 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.

profile

var 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.

rotation

var rotation: Int?

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.

sampleAspectRatio

var sampleAspectRatio: AspectRatio?

scanType

var scanType: String?

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

transferCharacteristics

var transferCharacteristics: 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

var width: Int?

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