Struct web_audio_api::buffer::AudioBuffer

pub struct AudioBuffer { /* fields omitted */ }

Memory-resident audio asset, basically a matrix of channels * samples

An AudioBuffer has copy-on-write semantics, so it is cheap to clone.

Implementations

impl AudioBuffer

pub fn new(channels: usize, len: usize, sample_rate: SampleRate) -> Self

Allocate a silent audiobuffer with given channel and samples count.

pub fn from_channels(
    channels: Vec<ChannelData>,
    sample_rate: SampleRate
) -> Self

Create a multi-channel audiobuffer.

pub fn number_of_channels(&self) -> usize

Number of channels in this AudioBuffer

pub fn sample_len(&self) -> usize

Number of samples per channel in this AudioBuffer

pub fn sample_rate(&self) -> SampleRate

Sample rate of this AudioBuffer in Hertz

pub fn duration(&self) -> f64

Duration in seconds of the AudioBuffer

pub fn channels(&self) -> &[ChannelData]

Channel data as slice

pub fn channels_mut(&mut self) -> &mut [ChannelData]

Channel data as slice (mutable)

pub fn channel_data(&self, index: usize) -> &ChannelData

Get the samples from this specific channel.

Panics if the index is greater than the available number of channels

pub fn channel_data_mut(&mut self, index: usize) -> &mut ChannelData

Get the samples (mutable) from this specific channel.

Panics if the index is greater than the available number of channels

pub fn modify_channels<F: Fn(&mut ChannelData)>(&mut self, fun: F)

Modify every channel in the same way

pub fn extend(&mut self, other: &Self)

Extends an AudioBuffer with the contents of another.

This function will panic if the sample_rate and channel_count are not equal

pub fn extend_alloc(&mut self, other: &FixedAudioBuffer)

Extends an AudioBuffer with an FixedAudioBuffer

This assumes the sample_rate matches. No up/down-mixing is performed

pub fn split(self, sample_len: u32) -> Vec<AudioBuffer>

Split an AudioBuffer in chunks with length sample_len.

The last chunk may be shorter than sample_len

pub fn split_off(&mut self, index: u32) -> AudioBuffer

Split an AudioBuffer in two at the given index.

pub fn resample(&mut self, sample_rate: SampleRate)

Resample to the desired sample rate.

This changes the sample_length of the buffer.

use web_audio_api::SampleRate;
use web_audio_api::buffer::{ChannelData, AudioBuffer};

let channel = ChannelData::from(vec![1., 2., 3., 4., 5.]);
let mut buffer = AudioBuffer::from_channels(vec![channel], SampleRate(48_000));

// upmix from 48k to 96k Hertz sample rate
buffer.resample(SampleRate(96_000));

assert_eq!(
    buffer.channel_data(0),
    &ChannelData::from(vec![1., 1., 2., 2., 3., 3., 4., 4., 5., 5.,])
);

assert_eq!(buffer.sample_rate().0, 96_000);

Trait Implementations

impl Clone for AudioBuffer

fn clone(&self) -> AudioBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioBuffer

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

Formats the value using the given formatter.

impl FromIterator<AudioBuffer> for AudioBuffer

fn from_iter<I: IntoIterator<Item = AudioBuffer>>(iter: I) -> Self

Creates a value from an iterator.