Struct ggez::audio::Source

pub struct Source { /* fields omitted */ }

A source of audio data that is connected to an output channel and ready to play. It will stop playing when dropped.

Methods

impl Source

pub fn new<P: AsRef<Path>>(context: &mut Context, path: P) -> GameResult<Self>

Create a new Source from the given file.

pub fn from_data(context: &mut Context, data: SoundData) -> GameResult<Self>

Creates a new Source using the given SoundData object.

Trait Implementations

impl SoundSource for Source

fn play_later(&self) -> GameResult

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

fn play_detached(&mut self) -> GameResult

Play source "in the background"; cannot be stopped

fn set_repeat(&mut self, repeat: bool)

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

fn set_fade_in(&mut self, dur: Duration)

Sets the fade-in time of the source

fn set_pitch(&mut self, ratio: f32)

Sets the speed ratio (by adjusting the playback speed)

fn repeat(&self) -> bool

Gets whether or not the source is set to repeat.

fn pause(&self)

Pauses playback

fn resume(&self)

Resumes playback

fn stop(&mut self)

Stops playback

fn stopped(&self) -> bool

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

fn volume(&self) -> f32

Gets the current volume.

fn set_volume(&mut self, value: f32)

Sets the current volume.

fn paused(&self) -> bool

Get whether or not the source is paused.

fn playing(&self) -> bool

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

fn elapsed(&self) -> Duration

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

fn set_query_interval(&mut self, t: Duration)

Set the update interval of the internal sample counter.

fn play(&mut self) -> GameResult

Plays the audio source; restarts the sound if currently playing

impl Debug for Source

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.