Struct cauldron::audio::AudioSegment

pub struct AudioSegment { /* fields omitted */ }

AudioSegment is returned to user to perform various operations and get decoded stream, audio info or encode to different format.

Methods

impl AudioSegment

pub fn read(filename: &'static str, flag: CodecFlag) -> Result<AudioSegment>

Constructs a new AudioSegment.

Example

use cauldron::audio::AudioSegment;
use cauldron::codecs::CodecFlag;

match AudioSegment::read("./samples/wav/test-s24le.wav", CodecFlag::WAV) {
  Ok(f)  => f,
  Err(e) => panic!("Couldn't open example file: {}", e)
};

read audio file from file path and returns AudioSegment

pub fn info(&self) -> AudioInfo

returns audio info as AudioInfo

pub fn number_channels(&self) -> usize

pub fn duration(&self) -> f32

Returns the duration of the audio file in seconds

duration = (total_samples / no_channels) / sampling_rate

pub fn bitrate(&self) -> u32

Returns bitrate of the audio in kbps

pub fn samples<'a, S: Sample + 'a>(
    &'a mut self
) -> Box<dyn AudioSamplesIterator<S> + 'a>

Returns an iterator on samples

Trait Implementations

impl Display for AudioSegment

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

Formats the value using the given formatter.