Struct VideoFrame

pub struct VideoFrame(/* private fields */);

A video frame. Thin wrapper around GenericFrame. Like a frame but has specific video properties.

Implementations

impl VideoFrame

pub const fn width(&self) -> usize

Returns the width of the frame.

pub const fn height(&self) -> usize

Returns the height of the frame.

pub fn sample_aspect_ratio(&self) -> Rational

Returns the sample aspect ratio of the frame.

pub fn set_sample_aspect_ratio( &mut self, sample_aspect_ratio: impl Into<Rational>, )

Sets the sample aspect ratio of the frame.

pub const fn is_keyframe(&self) -> bool

Returns true if the frame is a keyframe.

pub const fn pict_type(&self) -> AVPictureType

Returns the picture type of the frame.

pub const fn set_pict_type(&mut self, pict_type: AVPictureType)

Sets the picture type of the frame.

pub fn data(&self, index: usize) -> Option<Const<'_, FrameData>>

Returns a reference to the data of the frame. By specifying the index of the plane.

pub fn data_mut(&mut self, index: usize) -> Option<Mut<'_, FrameData>>

Returns a mutable reference to the data of the frame. By specifying the index of the plane.

pub const fn format(&self) -> AVPixelFormat

Get the pixel format of the frame.

pub fn builder() -> VideoFrameBuilder

Creates a new VideoFrame

Methods from Deref<Target = GenericFrame>

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

Returns the presentation timestamp of the frame, in time_base units.

pub fn set_pts(&mut self, pts: Option<i64>)

Sets the presentation timestamp of the frame, in time_base units.

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

Returns the duration of the frame, in time_base units.

pub fn set_duration(&mut self, duration: Option<i64>)

Sets the duration of the frame, in time_base units.

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

Returns the best effort timestamp of the frame, in time_base units.

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

Returns the decoding timestamp of the frame, in time_base units.

pub fn time_base(&self) -> Rational

Returns the time base of the frame.

pub fn set_time_base(&mut self, time_base: impl Into<Rational>)

Sets the time base of the frame.

pub fn linesize(&self, index: usize) -> Option<i32>

Returns the linesize of the frame, in bytes.

Trait Implementations

impl Clone for VideoFrame

fn clone(&self) -> VideoFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VideoFrame

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

Formats the value using the given formatter.

impl Deref for VideoFrame

type Target = GenericFrame

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for VideoFrame

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.