Struct WaveFile

pub struct WaveFile { /* private fields */ }

Implementations

impl WaveFile

pub fn open<S: Into<String>>(path: S) -> Result<WaveFile, WaveError>

Constructs a new WaveFile.

Example

use wavefile::{WaveFile,WaveError};

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

pub fn channels(&self) -> usize

The number of audio channels in the file.

pub fn sample_rate(&self) -> usize

The number of samples present for one second of audio.

pub fn len(&self) -> usize

The total number of frames present in the file. Each frame will contain channels() number of samples.

pub fn bits_per_sample(&self) -> usize

pub fn data_format(&self) -> Format

pub fn speakers(&self) -> Option<Vec<SpeakerPosition>>

pub fn info(&self) -> WaveInfo

Returns a copy of the WaveInfo for this file, parsed from the file header.

pub fn iter(&self) -> WaveFileIterator<'_>

Returns an iterator which yields each individual Frame successively until it reaches the end of the file.

Example

use wavefile::WaveFile;

let wav = WaveFile::open("./fixtures/test-s24le.wav").unwrap();

for frame in wav.iter() {
  println!("{:?}", frame);
}