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.

• MDN documentation: https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer
• specification: https://webaudio.github.io/web-audio-api/#AudioBuffer
• see also: AsBaseAudioContext::create_buffer

Implementations

impl AudioBuffer

pub fn new(options: AudioBufferOptions) -> Self

Allocate a silent audiobuffer with AudioBufferOptions

pub fn from(samples: Vec<Vec<f32>>, sample_rate: SampleRate) -> Self

Convert raw samples to an AudioBuffer

The outer Vec determine the channels. The inner Vecs should have the same length.

Panics

This function will panic if samples is an empty Vec or if any of its elements have different lengths.

pub fn number_of_channels(&self) -> usize

Number of channels in this AudioBuffer

pub fn length(&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 copy_from_channel(&self, destination: &mut [f32], channel_number: usize)

Copy data from a given channel to the given Vec

pub fn copy_from_channel_with_offset(
    &self,
    destination: &mut [f32],
    channel_number: usize,
    offset: usize
)

Copy data from a given channel to the given Vec starting at offset

pub fn copy_to_channel(&mut self, source: &[f32], channel_number: usize)

Copy data from a given source to the given channel.

pub fn copy_to_channel_with_offset(
    &mut self,
    source: &[f32],
    channel_number: usize,
    offset: usize
)

Copy data from a given source to the given channel starting at offset.

pub fn get_channel_data(&self, channel_number: usize) -> &[f32]

Return a read-only copy of the underlying data of the channel

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.