Struct AudioStreamInfo 

pub struct AudioStreamInfo { /* private fields */ }

Information about an audio stream within a media file.

This struct contains all metadata needed to understand and process an audio stream, including sample rate, channel layout, and codec information.

Construction

Use AudioStreamInfo::builder() for fluent construction:

use ff_format::stream::AudioStreamInfo;
use ff_format::SampleFormat;
use ff_format::codec::AudioCodec;

let info = AudioStreamInfo::builder()
    .index(1)
    .codec(AudioCodec::Aac)
    .sample_rate(48000)
    .channels(2)
    .build();

Implementations

impl AudioStreamInfo

pub fn builder() -> AudioStreamInfoBuilder

Creates a new builder for constructing AudioStreamInfo.

Examples

use ff_format::stream::AudioStreamInfo;
use ff_format::codec::AudioCodec;
use ff_format::SampleFormat;

let info = AudioStreamInfo::builder()
    .index(1)
    .codec(AudioCodec::Aac)
    .sample_rate(48000)
    .channels(2)
    .build();

pub const fn index(&self) -> u32

Returns the stream index within the container.

pub const fn codec(&self) -> AudioCodec

Returns the audio codec.

pub fn codec_name(&self) -> &str

Returns the codec name as reported by the demuxer.

pub const fn sample_rate(&self) -> u32

Returns the sample rate in Hz.

pub const fn channels(&self) -> u32

Returns the number of audio channels.

The type is u32 to match FFmpeg’s AVCodecParameters::ch_layout.nb_channels and professional audio APIs. When passing to rodio or cpal (which require u16), cast with info.channels() as u16 — channel counts never exceed u16::MAX in practice.

pub const fn channel_layout(&self) -> ChannelLayout

Returns the channel layout.

pub const fn sample_format(&self) -> SampleFormat

Returns the sample format.

pub const fn duration(&self) -> Option<Duration>

Returns the stream duration, if known.

pub const fn bitrate(&self) -> Option<u64>

Returns the bitrate in bits per second, if known.

pub fn language(&self) -> Option<&str>

Returns the language code, if specified.

pub const fn is_mono(&self) -> bool

Returns true if this is a mono stream.

pub const fn is_stereo(&self) -> bool

Returns true if this is a stereo stream.

pub const fn is_surround(&self) -> bool

Returns true if this is a surround sound stream (more than 2 channels).

Trait Implementations

impl Clone for AudioStreamInfo

fn clone(&self) -> AudioStreamInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioStreamInfo

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

Formats the value using the given formatter.

impl Default for AudioStreamInfo

fn default() -> AudioStreamInfo

Returns the “default value” for a type.