Struct nannou_audio::stream::Stream

pub struct Stream<M> { /* fields omitted */ }

A clone-able handle around an audio stream.

Implementations

impl<M> Stream<M>

pub fn play(&self) -> Result<(), PlayStreamError>

Command the audio device to start processing this stream.

Calling this will activate capturing/rendering, in turn calling the given audio capture/render function.

Has no effect if the stream is already running.

pub fn pause(&self) -> Result<(), PauseStreamError>

Command the audio device to stop processing this stream.

Calling this will pause rendering/capturing.

Has no effect is the stream was already paused.

pub fn is_playing(&self) -> bool

Whether or not the stream is currently playing.

pub fn is_paused(&self) -> bool

Whether or not the stream is currently paused.

pub fn send<F>(
    &self,
    update: F
) -> Result<(), SendError<Box<dyn FnMut(&mut M) + Send + 'static>>> where
    F: FnOnce(&mut M) + Send + 'static, 

Send the given model update to the audio thread to be applied ASAP.

If the audio is currently rendering, the update will be applied immediately after the function call completes.

If the stream is currently paused, the update will be applied immediately.

Note: This function will be applied on the real-time audio thread so users should avoid performing any kind of I/O, locking, blocking, (de)allocations or anything that may run for an indeterminate amount of time.

pub fn cpal_config(&self) -> &StreamConfig

The config with which the inner CPAL stream was created.

This should match the actual stream config that is running. If not, there may be a bug in CPAL. However, note that if the sample_format does not match, this just means that nannou is doing a conversion behind the scenes as the hardware itself does not support the target format.

Trait Implementations

impl<M> Clone for Stream<M>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.