Trait ggez::audio::SoundSource[−][src]

pub trait SoundSource {
    fn play_later(&self) -> GameResult;

    fn play_detached(&mut self, ctx: &Context) -> GameResult;

    fn set_repeat(&mut self, repeat: bool);

    fn set_fade_in(&mut self, dur: Duration);

    fn set_pitch(&mut self, ratio: f32);

    fn repeat(&self) -> bool;

    fn pause(&self);

    fn resume(&self);

    fn stop(&mut self, ctx: &Context) -> GameResult;

    fn stopped(&self) -> bool;

    fn volume(&self) -> f32;

    fn set_volume(&mut self, value: f32);

    fn paused(&self) -> bool;

    fn playing(&self) -> bool;

    fn elapsed(&self) -> Duration;

    fn set_query_interval(&mut self, t: Duration);

    fn play(&mut self, ctx: &Context) -> GameResult { ... }
}

A trait defining the operations possible on a sound; it is implemented by both Source and SpatialSource.

Required methods

fn play_later(&self) -> GameResult[src]

Plays the SoundSource; waits until done if the sound is currently playing

fn play_detached(&mut self, ctx: &Context) -> GameResult[src]

Play source "in the background"; cannot be stopped

fn set_repeat(&mut self, repeat: bool)[src]

Sets the source to repeat playback infinitely on next play()

fn set_fade_in(&mut self, dur: Duration)[src]

Sets the fade-in time of the source

fn set_pitch(&mut self, ratio: f32)[src]

Sets the speed ratio (by adjusting the playback speed)

fn repeat(&self) -> bool[src]

Gets whether or not the source is set to repeat.

fn pause(&self)[src]

Pauses playback

fn resume(&self)[src]

Resumes playback

fn stop(&mut self, ctx: &Context) -> GameResult[src]

Stops playback

fn stopped(&self) -> bool[src]

Returns whether or not the source is stopped -- that is, has no more data to play.

fn volume(&self) -> f32[src]

Gets the current volume.

fn set_volume(&mut self, value: f32)[src]

Sets the current volume.

fn paused(&self) -> bool[src]

Get whether or not the source is paused.

fn playing(&self) -> bool[src]

Get whether or not the source is playing (ie, not paused and not stopped).

fn elapsed(&self) -> Duration[src]

Get the time the source has been playing since the last call to play().

Time measurement is based on audio samples consumed, so it may drift from the system

fn set_query_interval(&mut self, t: Duration)[src]

Set the update interval of the internal sample counter.

This parameter determines the precision of the time measured by elapsed().

Loading content...

Provided methods

fn play(&mut self, ctx: &Context) -> GameResult[src]

Plays the audio source; restarts the sound if currently playing

Loading content...

Implementors

impl SoundSource for Source[src]

impl SoundSource for SpatialSource[src]

fn play_later(&self) -> GameResult[src]

Plays the SpatialSource; waits until done if the sound is currently playing.

Loading content...