Struct StreamHandle 

pub struct StreamHandle { /* private fields */ }

Controls one playing AudioStream, as returned by crate::Audio::play_stream.

Dropping the handle does not stop the stream; it plays until StreamHandle::stop. Clones refer to the same stream. Changes apply from the next audio block, and volume changes, pausing and stopping ramp over that block so they do not click.

Implementations

impl StreamHandle

pub fn set_volume(&self, volume: f32)

Set the volume as a linear amplitude (1.0 is the stream’s own level, 0.0 silence).

pub fn volume(&self) -> f32

The current linear volume.

pub fn pause(&self)

Pause: the stream fades out over one audio block, then outputs silence and is not asked for samples until resumed.

pub fn resume(&self)

Resume a paused stream where it left off, fading back in over one audio block.

pub fn stop(&self)

Stop the stream for good; it fades out over one audio block and is then dropped from the mixer.

pub fn is_playing(&self) -> bool

Whether the stream is audible: started, not paused and not stopped.

pub fn is_paused(&self) -> bool

Whether the stream is paused.

pub fn is_pending(&self) -> bool

Whether the stream is still waiting for audio to start.

pub fn is_finished(&self) -> bool

Whether the stream was stopped.

Trait Implementations

impl Clone for StreamHandle

fn clone(&self) -> StreamHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamHandle

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

Formats the value using the given formatter.