Struct awedio::manager::Renderer

pub struct Renderer { /* private fields */ }

Final mixed samples are pulled from the Renderer.

Samples are delivered via the Renderer to a backend. Different backends are implemented in external crates for different platforms and use cases.

The backend is responsible for:

1. storing the renderer
2. calling renderer.set_output_channel_count_and_sample_rate()
3. periodically calling renderer.on_start_of_batch() followed by some number of renderer.next_sample() calls (normally enough to fill some number of milliseconds of an output buffer).

Implementations

impl Renderer

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 that the rendered should return to the backend.

Trait Implementations

impl Sound for Renderer

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

Get the next sample. MetadataChanged will only be returned from Renderer if set_output_channel_count_and_sample_rate was called. If Paused is returned the backend may choose to pause itself or play silence (e.g. .next_sample().unwrap_or(0)). Finished will be returned if no sounds are playing and the Manager of the Renderer has been dropped.

fn on_start_of_batch(&mut self)

Inform the playing or queued sounds that a new batch of samples will be requested. This must only be called when the next sample to be delivered from next_sample is for the first channel.

See Sound::on_start_of_batch

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