Struct VideoFrame 

pub struct VideoFrame { /* private fields */ }

One exported video frame: tightly packed 8-bit pixels plus metadata.

The byte buffer is owned and has no row padding — as_bytes().len() equals width * height * layout.bytes_per_pixel() and the row stride equals width * layout.bytes_per_pixel(). This is the shape ML/CV consumers expect (feed it straight into an ndarray view, a tensor, or an image encoder).

Implementations

impl VideoFrame

pub fn width(&self) -> u32

Frame width in pixels.

pub fn height(&self) -> u32

Frame height in pixels.

pub fn layout(&self) -> PixelLayout

The packed pixel layout of as_bytes.

pub fn pts_us(&self) -> Option<i64>

Post-filter presentation time in microseconds, normalized to the start of the extraction window (the stream start when no start_time_us was set). Vsync passthrough preserves the source timing one-to-one; None when the frame carried no usable timestamp.

pub fn index(&self) -> u64

0-based export index (counts delivered frames in order).

pub fn as_bytes(&self) -> &[u8]

The packed pixel bytes. Length is width * height * bytes_per_pixel; rows are tight (row_bytes() each) and top-down.

pub fn into_vec(self) -> Vec<u8>

Consumes the frame and returns the owned packed buffer (no copy).

pub fn row_bytes(&self) -> usize

Bytes per row: width * layout.bytes_per_pixel().

Trait Implementations

impl Debug for VideoFrame

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

Formats the value using the given formatter.

impl Drop for VideoFrame

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.