Struct Frame 

pub struct Frame {
    pub data: FrameData,
    pub pts: i64,
    pub pkt_dts: i64,
    pub best_effort_timestamp: i64,
    pub duration: i64,
    pub time_base: Rational,
    pub flags: FrameFlags,
    pub repeat_pict: i32,
    pub metadata: Metadata,
    pub side_data: Vec<FrameSideData>,
}

Decoded frame, matching FFmpeg’s AVFrame concept.

Fields

data: FrameData

pts: i64

Presentation timestamp in time_base units.

pkt_dts: i64

Decompression timestamp, copied from the packet that triggered output.

best_effort_timestamp: i64

Best-effort timestamp estimated by the framework.

duration: i64

Duration in time_base units.

time_base: Rational

Time base for pts/duration.

flags: FrameFlags

repeat_pict: i32

Extra flag to indicate a picture should be decoded but displayed twice (or according to repeat_pict). Matches FFmpeg’s AVFrame.repeat_pict.

metadata: Metadata

Metadata key-value pairs.

side_data: Vec<FrameSideData>

Side data associated with this frame.

Implementations

impl Frame

pub fn new_video(width: u32, height: u32, format: PixelFormat) -> Self

Create a new video frame.

pub fn new_audio( nb_samples: u32, format: SampleFormat, sample_rate: u32, channel_layout: ChannelLayout, ) -> Self

Create a new audio frame.

pub fn is_video(&self) -> bool

Returns true if this is a video frame.

pub fn is_audio(&self) -> bool

Returns true if this is an audio frame.

pub fn video(&self) -> Option<&VideoFrameData>

Get video data, if this is a video frame.

pub fn video_mut(&mut self) -> Option<&mut VideoFrameData>

Get mutable video data, if this is a video frame.

pub fn audio(&self) -> Option<&AudioFrameData>

Get audio data, if this is an audio frame.

pub fn audio_mut(&mut self) -> Option<&mut AudioFrameData>

Get mutable audio data, if this is an audio frame.

pub fn get_side_data( &self, data_type: FrameSideDataType, ) -> Option<&FrameSideData>

Get side data of a specific type.

pub fn add_side_data(&mut self, side_data: FrameSideData)

Add side data to the frame.

Does NOT replace existing data of the same type — multiple entries of the same type are allowed, matching FFmpeg’s av_frame_new_side_data. Use remove_side_data first if you need unique-per-type behavior.

pub fn remove_side_data(&mut self, data_type: FrameSideDataType)

Remove side data of a specific type.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.