Struct bevy_internal::audio::AudioSourceBundle

pub struct AudioSourceBundle<Source = AudioSource>
where
    Source: Asset + Decodable,
{
    pub source: Handle<Source>,
    pub settings: PlaybackSettings,
}

Bundle for playing a sound.

Insert this bundle onto an entity to trigger a sound source to begin playing.

If the handle refers to an unavailable asset (such as if it has not finished loading yet), the audio will not begin playing immediately. The audio will play when the asset is ready.

When Bevy begins the audio playback, an AudioSink component will be added to the entity. You can use that component to control the audio settings during playback.

Fields

source: Handle<Source>

Asset containing the audio data to play.

settings: PlaybackSettings

Initial settings that the audio starts playing with. If you would like to control the audio while it is playing, query for the AudioSink component. Changes to this component will not be applied to already-playing audio.

Trait Implementations

impl<T> Default for AudioSourceBundle<T>

where T: Decodable + Asset,

fn default() -> AudioSourceBundle<T>

Returns the “default value” for a type.

impl<Source> Bundle for AudioSourceBundle<Source>

where Source: Asset + Decodable,

impl<Source> DynamicBundle for AudioSourceBundle<Source>

where Source: Asset + Decodable,