Struct rodio::Sink

[+] Show declaration

pub struct Sink { /* fields omitted */ }

[−] Expand description

Handle to an device that outputs sounds.

Dropping the Sink stops all sounds. You can use detach if you want the sounds to continue playing.

Methods

impl Sink[−]

pub fn new(device: &Device) -> Sink[−]

Builds a new Sink, beginning playback on a Device.

pub fn new_idle() -> (Sink, SourcesQueueOutput<f32>)[−]

Builds a new Sink.

pub fn append<S>(&self, source: S) where
    S: Source + Send + 'static,
    S::Item: Sample,
    S::Item: Send, [−]

Appends a sound to the queue of sounds to play.

pub fn volume(&self) -> f32[−]

Gets the volume of the sound.

The value 1.0 is the "normal" volume (unfiltered input). Any value other than 1.0 will multiply each sample by this value.

pub fn set_volume(&self, value: f32)[−]

Changes the volume of the sound.

The value 1.0 is the "normal" volume (unfiltered input). Any value other than 1.0 will multiply each sample by this value.

pub fn play(&self)[−]

Resumes playback of a paused sink.

No effect if not paused.

pub fn pause(&self)[−]

Pauses playback of this sink.

No effect if already paused.

A paused sink can be resumed with play().

pub fn is_paused(&self) -> bool[−]

Gets if a sink is paused

Sinks can be paused and resumed using pause() and play(). This returns true if the sink is paused.

pub fn stop(&self)[−]

Stops the sink by emptying the queue.

pub fn detach(self)[−]

Destroys the sink without stopping the sounds that are still playing.

pub fn sleep_until_end(&self)[−]

Sleeps the current thread until the sound ends.

pub fn empty(&self) -> bool[−]

Returns true if this sink has no more sounds to play.

pub fn len(&self) -> usize[−]

Returns the number of sounds currently in the queue.

Trait Implementations

impl Drop for Sink[+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.