Struct awedio::sounds::SoundMixer

pub struct SoundMixer { /* private fields */ }

Mix multiple sounds together to be played simultaneously.

The Manager contains a SoundMixer so you might not need to crate one yourself but instead add multiple sounds on the Manager.

If a Sound returns an Error from next_sample, the error is logged and the Sound is dropped but other sounds keep playing.

Implementations

impl SoundMixer

pub fn new(output_channel_count: u16, output_sample_rate: u32) -> Self

Create a new empty sound mixer with an output channel count and sample rate that all added sounds will be converted to.

pub fn set_output_channel_count_and_sample_rate( &mut self, output_channel_count: u16, output_sample_rate: u32 )

Set the output channel count and sample rate. Added sounds will be converted to the output values. Must only be called when the next sample is for the first channel in the frame.

Trait Implementations

impl AddSound for SoundMixer

fn add(&mut self, sound: Box<dyn Sound>)

Add a sound to be played. When or how the sound is played is implementation specific.

impl ClearSounds for SoundMixer

fn clear(&mut self)

Remove all audio sounds.

impl Sound for SoundMixer

fn next_sample(&mut self) -> Result<NextSample, Error>

Guaranteed to not return an Error.

fn channel_count(&self) -> u16

Returns the number of channels.

fn sample_rate(&self) -> u32

Returns the number of samples per second for each channel for this sound (e.g. 44,100).

fn on_start_of_batch(&mut self)

Called whenever a new batch of audio samples is requested by the backend.

fn next_frame(&mut self) -> Result<Vec<i16>, Result<NextSample, Error>>

Returns the next sample for all channels.

fn append_next_frame_to( &mut self, samples: &mut Vec<i16> ) -> Result<(), Result<NextSample, Error>>

Same as next_frame but samples are appended into an existing Vec.

fn into_memory_sound(self) -> Result<MemorySound, Error>

where Self: Sized,

Read the entire sound into memory. MemorySound can be cloned for efficient reuse. See MemorySound::from_sound.

fn loop_from_memory(self) -> Result<MemorySound, Error>

where Self: Sized,

Read the entire sound into memory and loop indefinitely.

fn controllable(self) -> (Controllable<Self>, Controller<Self>)

where Self: Sized,

Allow this sound to be controlled after it has started playing with a Controller.

fn with_async_completion_notifier( self ) -> (AsyncCompletionNotifier<Self>, Receiver<()>)

where Self: Sized,

Get notified via a tokio::sync::oneshot::Receiver when this sound has Finished.

fn with_completion_notifier(self) -> (CompletionNotifier<Self>, Receiver<()>)

where Self: Sized,

Get notified via a std::sync::mpsc::Receiver when this sound has Finished.

fn with_adjustable_volume(self) -> AdjustableVolume<Self>

where Self: Sized,

Allow the volume of the sound to be adjustable with set_volume.

fn with_adjustable_volume_of( self, volume_adjustment: f32 ) -> AdjustableVolume<Self>

where Self: Sized,

Allow the volume of the sound to be adjustable with set_volume and set the initial volume adjustment.

fn with_adjustable_speed(self) -> AdjustableSpeed<Self>

where Self: Sized,

Allow the speed of the sound to be adjustable with set_speed.

fn with_adjustable_speed_of( self, speed_adjustment: f32 ) -> AdjustableSpeed<Self>

where Self: Sized,

Allow the speed of the sound to be adjustable with set_speed and set the initial speed adjustment.

fn pausable(self) -> Pausable<Self>

where Self: Sized,

Allow for the sound to be pausable with set_paused. Starts unpaused.

fn paused(self) -> Pausable<Self>

where Self: Sized,

Allow for the sound to be pausable with set_paused. Starts paused.

fn finish_after(self, duration: Duration) -> FinishAfter<Self>

where Self: Sized,

Play the first duration of the sound, then finish even if samples remain.

fn skip(&mut self, duration: Duration) -> Result<bool, Error>

Skip the next duration of samples.