Enum StreamInfo 

#[non_exhaustive]
pub enum StreamInfo {
    Video {
        id: u32,
        codec: CodecKind,
        time_base: Rational,
        geometry: VideoGeometry,
        extra_data: Bytes,
    },
    Audio {
        id: u32,
        codec: CodecKind,
        time_base: Rational,
        extra_data: Bytes,
        sample_rate: u32,
        channels: u16,
    },
}

Description of a media stream/track.

Video and Audio are separate variants — rather than one shape with optional fields — so a track can never claim video dimensions it doesn’t have, or omit dimensions it does: the invariant lives in the type, not in a convention callers must remember. Audio is also used for subtitle tracks (WebVtt/Tx3g) — there is no separate Subtitle variant yet; sample_rate/channels are 0 there (not applicable, not “silence”).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Video

A video track — always carries pixel dimensions.

Fields

id: u32

Track or stream index.

codec: CodecKind

Codec kind of this track.

time_base: Rational

Timebase for timestamps in packets on this track.

geometry: VideoGeometry

Pixel dimensions.

extra_data: Bytes

Extra header data (e.g. AVCC / extradata).

Audio

A non-video track (audio, or subtitle until a dedicated variant exists) — no geometry.

Fields

id: u32

Track or stream index.

codec: CodecKind

Codec kind of this track.

time_base: Rational

Timebase for timestamps in packets on this track.

extra_data: Bytes

Extra header data (e.g. AVCC / extradata).

sample_rate: u32

Sample rate in Hz. 0 when unknown or not applicable (e.g. a subtitle track, or a source that doesn’t carry this yet).

channels: u16

Channel count. 0 when unknown or not applicable.

Implementations

impl StreamInfo

pub const fn id(&self) -> u32

Track or stream index, regardless of kind.

pub fn with_id(self, id: u32) -> Self

Return a copy with a different track id (e.g. renumbering before mux registration).

pub const fn codec(&self) -> CodecKind

Codec kind of this track.

pub const fn time_base(&self) -> Rational

Timebase for timestamps in packets on this track.

pub const fn extra_data(&self) -> &Bytes

Extra header data (e.g. AVCC / extradata).

pub const fn geometry(&self) -> Option<VideoGeometry>

Pixel dimensions, if this is a video track.

pub const fn sample_rate(&self) -> Option<u32>

Sample rate in Hz, if this is a non-video track. Some(0) means unknown/not applicable, not “silence” — see Self::Audio.

pub const fn channels(&self) -> Option<u16>

Channel count, if this is a non-video track. Some(0) means unknown/not applicable — see Self::Audio.

Trait Implementations

impl Clone for StreamInfo

fn clone(&self) -> StreamInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamInfo

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

Formats the value using the given formatter.

impl Eq for StreamInfo

impl PartialEq for StreamInfo

fn eq(&self, other: &StreamInfo) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StreamInfo