Struct amethyst_audio::AudioEmitter

pub struct AudioEmitter { /* fields omitted */ }

An audio source, add this component to anything that emits sound.

Methods

impl AudioEmitter

fn new() -> AudioEmitter

Creates a new AudioEmitter component initialized to the given positions. These positions will stay synced with Transform if the Transform component is available on this entity.

fn play(&mut self, source: &Source) -> Result<(), DecoderError>

Plays an audio source from this emitter.

fn set_picker(
    &mut self,
    picker: Box<FnMut(&mut AudioEmitter) -> bool + Send + Sync>
)

An emitter's picker will be called by the AudioSystem whenever the emitter runs out of sounds to play.

During callback the picker is separated from the emitter in order to avoid multiple aliasing. After the callback is complete, if the picker returned true then the picker that just finished will be reattached.

fn clear_picker(&mut self)

Clears the previously set picker.

Trait Implementations

impl Default for AudioEmitter

fn default() -> AudioEmitter

Returns the "default value" for a type.

impl Component for AudioEmitter

type Storage = BTreeStorage<Self>

Associated storage type for this component.