Struct BasicMixer 

pub struct BasicMixer { /* private fields */ }

A mixer that combines multiple AudioSources.

This simple mixer adds the samples from the given sources together, and optionally multiplies by a coefficient to give some headroom.

Examples

let sin1 = SineWave::new(0.5, 440.0);
let sin2 = SineWave::new(0.5, 220.0);

let mut mixer = BasicMixer::new();
let sin1 = mixer.add_source(sin1.into_shared());
mixer.add_source(sin2.into_shared());
mixer.remove_source(sin1);

Implementations

impl BasicMixer

pub fn new() -> Self

Construct a BasicMixer that simply adds samples and doesn’t multiply by anything.

pub fn with_coefficient(coefficient: f32) -> Self

Construct a BasicMixer that adds samples together, then multiplies by the given coefficient to reduce the chance of clipping.

Arguments

• coefficient – A number to multiply the final resulting samples by.

pub fn add_source(&mut self, source: SharedAudioSource) -> BasicMixerSource

Add a source to this mixer.

Arguments

• source – The audio source to add to this mixer.

Returns

A key to be used in remove_source to remove this source.

pub fn remove_source(&mut self, source: BasicMixerSource)

Removes the source indicated by source, if present.

Examples

let sin = SineWave::new(1.0, 440.0);
let mut mixer = BasicMixer::new();
let sin = mixer.add_source(sin.into_shared());
mixer.remove_source(sin);

Trait Implementations

impl AudioSource for BasicMixer

fn read(&mut self, buffer: &mut AudioBuffer<'_>) -> ReadResult

Consume audio data and attempt to fill the given buffer.

impl Default for BasicMixer

fn default() -> BasicMixer

Returns the “default value” for a type.