Struct VideoParams 

pub struct VideoParams {
    pub width: u32,
    pub height: u32,
    pub frame_rate: Rational,
    pub pixel_format: PixelFormat,
    pub color_space: ColorSpace,
    pub chroma_location: ChromaLocation,
    pub display_aspect_ratio: Option<Rational>,
    pub bit_depth: u8,
    pub bitrate_bps: Option<u64>,
}

Video stream encoding / decoding parameters.

Fields

width: u32

Frame width in pixels.

height: u32

Frame height in pixels.

frame_rate: Rational

Frame rate as a rational number (e.g. Rational::new(30, 1) for 30 fps, Rational::new(30000, 1001) for ≈29.97 fps).

pixel_format: PixelFormat

Pixel format (default: PixelFormat::Yuv420p).

color_space: ColorSpace

Colour space (default: ColorSpace::Bt709).

chroma_location: ChromaLocation

Chroma sample location (default: ChromaLocation::Left).

display_aspect_ratio: Option<Rational>

Display aspect ratio, if different from the storage aspect ratio.

bit_depth: u8

Bit depth per colour component (8 for standard, 10 or 12 for HDR).

bitrate_bps: Option<u64>

Target or measured peak bitrate in bits per second, if known.

Implementations

impl VideoParams

pub fn new(width: u32, height: u32, frame_rate: Rational) -> Self

Creates minimal VideoParams with width, height, and frame_rate.

All other fields receive sensible defaults:

• pixel_format = PixelFormat::Yuv420p
• color_space = ColorSpace::Bt709
• bit_depth = 8

pub fn storage_aspect_ratio(&self) -> Rational

Returns the storage aspect ratio width / height as a Rational.

pub fn effective_aspect_ratio(&self) -> Rational

Returns the display aspect ratio, falling back to the storage aspect ratio when not explicitly set.

pub fn is_valid(&self) -> bool

Returns true if the frame dimensions are valid (both non-zero).

pub fn pixel_count(&self) -> u64

Returns the total number of pixels per frame.

pub fn fps(&self) -> f64

Returns the frame rate as a floating-point number.

pub fn with_pixel_format(self, fmt: PixelFormat) -> Self

Builder-style setter for pixel format.

pub fn with_color_space(self, cs: ColorSpace) -> Self

Builder-style setter for colour space.

pub fn with_bit_depth(self, depth: u8) -> Self

Builder-style setter for bit depth.

pub fn with_bitrate(self, bps: u64) -> Self

Builder-style setter for bitrate.

Trait Implementations

impl Clone for VideoParams

fn clone(&self) -> VideoParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VideoParams

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

Formats the value using the given formatter.

impl PartialEq for VideoParams

fn eq(&self, other: &VideoParams) -> 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 VideoParams