Enum MediaBuffer 

pub enum MediaBuffer {
    Packet(Arc<Packet>),
    Video(Arc<UnboundObjectPoolRef<Video>>),
    Audio(Arc<Audio>),
    Eos,
}

The unit of data that flows between elements.

Compressed and uncompressed data are kept as distinct variants (rather than a single opaque Buffer type like GStreamer) because ffmpeg-next already gives us strongly-typed Packet/Frame types — collapsing them into one type would just mean unwrapping again downstream.

Payloads are Arc-wrapped so MediaBuffer is cheaply Clone — duplicating a buffer (e.g. crate::elements::Tee fanning packets out to a decode branch and a remux branch) is a refcount bump, never a copy of the encoded/decoded data.

Video specifically wraps an UnboundObjectPoolRef, not a plain ffmpeg::frame::Video — that’s what lets whichever element produced it (see crate::pool::UnboundObjectPool, owned as that element’s own struct field) get the underlying buffer back automatically once every Arc clone downstream has been dropped, instead of it just being freed.

Variants

Packet(Arc<Packet>)

Encoded media packet produced by a demuxer or encoder.

Its PTS, DTS, duration, stream index, and time base remain part of the packet contract while it travels through packet-level elements.

Video(Arc<UnboundObjectPoolRef<Video>>)

Decoded video frame whose backing storage returns to its producer’s crate::pool::UnboundObjectPool after the last Arc clone drops.

Treat the published frame as immutable. A transforming element creates a replacement frame and preserves PTS, duration, and color metadata unless it intentionally establishes a new timeline.

Audio(Arc<Audio>)

Decoded audio frame shared immutably between downstream branches.

Sample format, sample rate, channel layout, PTS, and duration describe the audio contract a transforming element must either preserve or deliberately replace.

Eos

Ordered end-of-stream marker.

Stateful elements flush delayed output before forwarding it, and muxers finalize their output after receiving it. Unlike crate::control::ControlMsg::Stop, this requests natural completion rather than abandoning buffered work.

Implementations

impl MediaBuffer

pub fn is_eos(&self) -> bool

Returns whether this buffer is the ordered MediaBuffer::Eos marker.

pub fn kind(&self) -> &'static str

Stable, human-readable variant name for diagnostics emitted when elements are wired to an incompatible media type.

Trait Implementations

impl Clone for MediaBuffer

fn clone(&self) -> MediaBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.