Struct CodecMetadata 

#[non_exhaustive]
pub struct CodecMetadata {
    pub bit_depth: Option<i32>,
    pub chroma_subsampling: Option<String>,
    pub coded_frame_rate: Option<FrameRate>,
    pub color_primaries: Option<ColorPrimaries>,
    pub height: Option<i32>,
    pub level: Option<String>,
    pub matrix_coefficients: Option<MatrixCoefficients>,
    pub profile: Option<String>,
    pub scan_type: Option<String>,
    pub transfer_characteristics: Option<TransferCharacteristics>,
    pub width: Option<i32>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bit_depth: Option<i32>

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

chroma_subsampling: Option<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.

coded_frame_rate: Option<FrameRate>

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

color_primaries: Option<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.

height: Option<i32>

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

level: Option<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.

matrix_coefficients: Option<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: Option<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.

scan_type: Option<String>

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

transfer_characteristics: Option<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: Option<i32>

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

Implementations

impl CodecMetadata

pub fn bit_depth(&self) -> Option<i32>

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

pub fn chroma_subsampling(&self) -> Option<&str>

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.

pub fn coded_frame_rate(&self) -> Option<&FrameRate>

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

pub fn color_primaries(&self) -> Option<&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.

pub fn height(&self) -> Option<i32>

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

pub fn level(&self) -> Option<&str>

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.

pub fn matrix_coefficients(&self) -> Option<&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.

pub fn profile(&self) -> Option<&str>

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.

pub fn scan_type(&self) -> Option<&str>

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

pub fn transfer_characteristics(&self) -> Option<&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.

pub fn width(&self) -> Option<i32>

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

impl CodecMetadata

pub fn builder() -> CodecMetadataBuilder

Creates a new builder-style object to manufacture CodecMetadata.

Trait Implementations

impl Clone for CodecMetadata

fn clone(&self) -> CodecMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodecMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CodecMetadata

fn eq(&self, other: &CodecMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CodecMetadata