Struct ggez::audio::SpatialSource

pub struct SpatialSource { /* fields omitted */ }

A source of audio data located in space relative to a listener's ears. Will stop playing when dropped.

Implementations

impl SpatialSource

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

Create a new SpatialSource from the given file.

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

Creates a new SpatialSource using the given SoundData object.

impl SpatialSource

pub fn set_position<P>(&mut self, pos: P) where
    P: Into<Point3<f32>>, 

Set location of the sound.

pub fn set_ears<P>(&mut self, left: P, right: P) where
    P: Into<Point3<f32>>, 

Set locations of the listener's ears

Trait Implementations

impl Debug for SpatialSource

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

Formats the value using the given formatter.

impl SoundSource for SpatialSource

pub fn play_later(&self) -> GameResult

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

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

Play source "in the background"; cannot be stopped

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

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

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

Sets the fade-in time of the source

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

Sets the speed ratio (by adjusting the playback speed)

pub fn repeat(&self) -> bool

Gets whether or not the source is set to repeat.

pub fn pause(&self)

Pauses playback

pub fn resume(&self)

Resumes playback

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

Stops playback

pub fn stopped(&self) -> bool

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

pub fn volume(&self) -> f32

Gets the current volume.

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

Sets the current volume.

pub fn paused(&self) -> bool

Get whether or not the source is paused.

pub fn playing(&self) -> bool

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

pub fn elapsed(&self) -> Duration

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

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

Set the update interval of the internal sample counter.

pub fn play(&mut self, ctx: &Context) -> GameResult

Plays the audio source; restarts the sound if currently playing