Struct awedio::sounds::wrappers::Controllable

pub struct Controllable<S: Sound> { /* private fields */ }

Wrap a Sound so that it can be controlled via a Controller even after it has been added to the Manager and/or started playing.

Since new sounds can be added after playing has started, if the inner sound returns Finished it will be converted to Paused by Controllable. Only after the controller has dropped and all sounds have played will Finished be returned;

Implementations

impl<S> Controllable<S>

where S: Sound,

pub fn new(inner: S) -> (Self, Controller<S>)

Wrap inner so it can be controlled.

Trait Implementations

impl<S> Sound for Controllable<S>

where S: Sound,

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 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 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.

impl<S> Wrapper for Controllable<S>

where S: Sound,

type Inner = S

The wrapped Sound type

fn inner(&self) -> &S

Get a reference to the wrapped inner Sound.

fn inner_mut(&mut self) -> &mut Self::Inner

Get a mutable reference to the wrapped inner Sound.

fn into_inner(self) -> S

Unwrap and return the previously wrapped Sound.