Struct web_audio_api::render::AudioRenderQuantum

pub struct AudioRenderQuantum { /* private fields */ }

Internal fixed length audio asset of RENDER_QUANTUM_SIZE sample frames for block rendering, basically a matrix of channels * [f32; RENDER_QUANTUM_SIZE] cf. https://webaudio.github.io/web-audio-api/#render-quantum

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

Implementations

impl AudioRenderQuantum

pub fn new(channel: AudioRenderQuantumChannel) -> Self

pub fn number_of_channels(&self) -> usize

Number of channels in this AudioRenderQuantum

pub fn set_number_of_channels(&mut self, n: usize)

Set number of channels in this AudioRenderQuantum

Note: if the new number is higher than the previous, the new channels will be filled with garbage.

Panics

This function will panic if the given number of channels is outside the [1, 32] range, 32 being defined by the MAX_CHANNELS constant.

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

Get the samples from this specific channel.

Panics

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

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

Get the samples (mutable) from this specific channel.

Panics

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

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

Channel data as slice

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

Channel data as slice (mutable)

pub fn mix(
    &mut self,
    computed_number_of_channels: usize,
    interpretation: ChannelInterpretation
)

Up/Down-mix to the desired number of channels

Panics

This function will panic if the given number of channels is outside the [1, 32] range, 32 being defined by the MAX_CHANNELS constant.

pub fn make_silent(&mut self)

Convert this buffer to silence

pub fn force_mono(&mut self)

Convert to a single channel buffer, dropping excess channels

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

Modify every channel in the same way

pub fn add(&mut self, other: &Self, interpretation: ChannelInterpretation)

Sum two AudioRenderQuantums

If the channel counts differ, the buffer with lower count will be upmixed.

pub fn set_channels_values_at(&mut self, sample_index: usize, values: &[f32])

Trait Implementations

impl Clone for AudioRenderQuantum

fn clone(&self) -> AudioRenderQuantum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioRenderQuantum

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

Formats the value using the given formatter.