[−][src]Struct rodio::Sink
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
[src]
pub fn new(device: &Device) -> Sink
[src]
Builds a new Sink
, beginning playback on a Device.
pub fn new_idle() -> (Sink, SourcesQueueOutput<f32>)
[src]
Builds a new Sink
.
pub fn append<S>(&self, source: S) where
S: Source + Send + 'static,
S::Item: Sample,
S::Item: Send,
[src]
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
[src]
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)
[src]
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)
[src]
Resumes playback of a paused sink.
No effect if not paused.
pub fn pause(&self)
[src]
Pauses playback of this sink.
No effect if already paused.
A paused sink can be resumed with play()
.
pub fn is_paused(&self) -> bool
[src]
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)
[src]
Stops the sink by emptying the queue.
pub fn detach(self)
[src]
Destroys the sink without stopping the sounds that are still playing.
pub fn sleep_until_end(&self)
[src]
Sleeps the current thread until the sound ends.
pub fn empty(&self) -> bool
[src]
Returns true if this sink has no more sounds to play.
pub fn len(&self) -> usize
[src]
Returns the number of sounds currently in the queue.
Trait Implementations
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,