Struct AudioSource 

pub struct AudioSource {
    pub handle: AssetHandle<SoundData>,
    pub volume: f32,
    pub looping: bool,
    pub autoplay: bool,
    pub state: Option<PlaybackState>,
}

An ECS component that makes an entity an emitter of sound.

Fields

handle: AssetHandle<SoundData>

A handle to the sound data to be played.

volume: f32

The volume of the sound, where 1.0 is normal volume.

looping: bool

Whether the sound should loop back to the beginning when it finishes.

autoplay: bool

Whether the sound should start playing automatically when this component is added.

state: Option<PlaybackState>

The internal playback state. This should be treated as read-only by most systems outside of the audio engine itself.

Implementations

impl AudioSource

pub fn new(handle: AssetHandle<SoundData>) -> Self

Creates a new AudioSource.

Trait Implementations

impl Clone for AudioSource

fn clone(&self) -> AudioSource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AudioSource

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

Formats the value using the given formatter.

impl Component for AudioSource