Trait Frame

pub trait Frame: DataFrame {
    // Required methods
    fn timestamp(&self) -> u64;
    fn codec(&self) -> Fourcc;
    fn flags(&self) -> FrameFlags;

    // Provided methods
    fn has_flag(&self, flag: FrameFlags) -> bool { ... }
    fn is_keyframe(&self) -> bool { ... }
    fn is_live(&self) -> bool { ... }
    fn is_multichannel(&self) -> bool { ... }
    fn is_encoded(&self) -> bool { ... }
    fn is_last(&self) -> bool { ... }
    fn has_params(&self) -> bool { ... }
    fn has_start_timestamp(&self) -> bool { ... }
    fn is_audio(&self) -> bool { ... }
    fn is_video(&self) -> bool { ... }
    fn is_metadata(&self) -> bool { ... }
}

Frame of the data (related to some timestamp, codec and with some flags)

Required Methods

fn timestamp(&self) -> u64

Timestamp in microseconds when frame should appear from start

fn codec(&self) -> Fourcc

Fourcc signature of the payload type

fn flags(&self) -> FrameFlags

Frame Flags (keyframe, last, multitrack, live etc.)

Provided Methods

fn has_flag(&self, flag: FrameFlags) -> bool

Check the flag presence

fn is_keyframe(&self) -> bool

true if frame is IDR (not depends on other frames)

fn is_live(&self) -> bool

true if frame is compressed

fn is_multichannel(&self) -> bool

true if frame is part of multichannel translation

fn is_encoded(&self) -> bool

true if frame is compressed

fn is_last(&self) -> bool

true if frame is last one in the seq

fn has_params(&self) -> bool

frame needs updated decoding params

fn has_start_timestamp(&self) -> bool

live stream has timestamp of starting of the translation

fn is_audio(&self) -> bool

Audio Frame

fn is_video(&self) -> bool

Video Frame

fn is_metadata(&self) -> bool

Metadata Frame

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors