Struct SoundList 

pub struct SoundList { /* private fields */ }

Play Sounds sequentially one after the other.

Only after a Sound has returned NextSample::Finished will the next Sound start playing.

If an Error is returned from a Sound it is dropped and the error is propagated to the caller. Calling next_sound again would continue with the next Sound in the list.

Implementations

impl SoundList

pub fn new() -> Self

Create a new empty SoundList.

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

Add a Sound to be played after any existing sounds have Finished.

pub fn insert(&mut self, index: usize, sound: Box<dyn Sound>)

Inserts a sound at position index, shifting all elements after it to the right.

Panics

Panics if index > len.

pub fn clear(&mut self)

Stop all sounds including the currently playing one.

pub fn len(&self) -> usize

Returns the number of sounds currently in the list.

Trait Implementations

impl AddSound for SoundList

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 SoundList

fn clear(&mut self)

Clear all sounds currently playing or scheduled to play.

impl Debug for SoundList

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

Formats the value using the given formatter.

impl Default for SoundList

fn default() -> Self

Returns the “default value” for a type.

impl From<SoundList> for Vec<Box<dyn Sound>>

fn from(list: SoundList) -> Self

Converts to this type from the input type.

impl From<Vec<Box<dyn Sound>>> for SoundList

fn from(sounds: Vec<Box<dyn Sound>>) -> Self

Converts to this type from the input type.

impl FromIterator<Box<dyn Sound>> for SoundList

fn from_iter<T: IntoIterator<Item = Box<dyn Sound>>>(iter: T) -> Self

Creates a value from an iterator.

impl Sound for SoundList

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. 48,000).

fn on_start_of_batch(&mut self)

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

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

Retrieve the next sample or notification if something has changed. The first sample is for the first channel and the second is the for second and so on until channel_count and then wraps back to the first channel. If any NextSample variant besides Sample is returned then the following NextSample::Sample is for the first channel. If a Sound has returned Paused it is expected that the consumer will call next_sample again in the future. If a Sound has returned Finished it is not expected for the consumer to call next_sample again but if called Finished will normally be returned again. After Finished has been returned, channel_count() and sample_rate() may return different values without MetadataChanged being returned.

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 stoppable(self) -> Stoppable<Self>

where Self: Sized,

Allow for the sound to be stoppable with set_stopped. A stopped sound returns Finished.

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.