Struct bevy::audio::Audio

pub struct Audio<Source = AudioSource>where
    Source: Asset + Decodable,{ /* private fields */ }

Use this Resource to play audio.

fn play_audio_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play(asset_server.load("my_sound.ogg"));
}

Implementations

impl<Source> Audio<Source>where Source: Asset + Decodable,

pub fn play(&self, audio_source: Handle<Source>) -> Handle<AudioSink>

Play audio from a Handle to the audio source

fn play_audio_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play(asset_server.load("my_sound.ogg"));
}

Returns a weak Handle to the AudioSink. If this handle isn’t changed to a strong one, the sink will be detached and the sound will continue playing. Changing it to a strong handle allows you to control the playback through the AudioSink asset.

fn play_audio_system(
    asset_server: Res<AssetServer>,
    audio: Res<Audio>,
    audio_sinks: Res<Assets<AudioSink>>,
) {
    // This is a weak handle, and can't be used to control playback.
    let weak_handle = audio.play(asset_server.load("my_sound.ogg"));
    // This is now a strong handle, and can be used to control playback.
    let strong_handle = audio_sinks.get_handle(weak_handle);
}

pub fn play_with_settings( &self, audio_source: Handle<Source>, settings: PlaybackSettings ) -> Handle<AudioSink>

Play audio from a Handle to the audio source with PlaybackSettings that allows looping or changing volume from the start.

fn play_audio_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play_with_settings(
        asset_server.load("my_sound.ogg"),
        PlaybackSettings::LOOP.with_volume(0.75),
    );
}

See Self::play on how to control playback once it’s started.

pub fn play_spatial( &self, audio_source: Handle<Source>, listener: Transform, gap: f32, emitter: Vec3 ) -> Handle<SpatialAudioSink>

Play audio from a Handle to the audio source, placing the listener at the given transform, an ear on each side separated by gap. The audio emitter will placed at emitter.

bevy_audio is not using HRTF for spatial audio, but is transforming the sound to a mono track, and then changing the level of each stereo channel according to the distance between the emitter and each ear by amplifying the difference between what the two ears hear.

fn play_spatial_audio_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    // Sound will be to the left and behind the listener
    audio.play_spatial(
        asset_server.load("my_sound.ogg"),
        Transform::IDENTITY,
        1.0,
        Vec3::new(-2.0, 0.0, 1.0),
    );
}

Returns a weak Handle to the SpatialAudioSink. If this handle isn’t changed to a strong one, the sink will be detached and the sound will continue playing. Changing it to a strong handle allows you to control the playback, or move the listener and emitter through the SpatialAudioSink asset.

fn play_spatial_audio_system(
    asset_server: Res<AssetServer>,
    audio: Res<Audio>,
    spatial_audio_sinks: Res<Assets<SpatialAudioSink>>,
) {
    // This is a weak handle, and can't be used to control playback.
    let weak_handle = audio.play_spatial(
        asset_server.load("my_sound.ogg"),
        Transform::IDENTITY,
        1.0,
        Vec3::new(-2.0, 0.0, 1.0),
    );
    // This is now a strong handle, and can be used to control playback, or move the emitter.
    let strong_handle = spatial_audio_sinks.get_handle(weak_handle);
}

pub fn play_spatial_with_settings( &self, audio_source: Handle<Source>, settings: PlaybackSettings, listener: Transform, gap: f32, emitter: Vec3 ) -> Handle<SpatialAudioSink>

Play spatial audio from a Handle to the audio source with PlaybackSettings that allows looping or changing volume from the start. The listener is placed at the given transform, an ear on each side separated by gap. The audio emitter is placed at emitter.

bevy_audio is not using HRTF for spatial audio, but is transforming the sound to a mono track, and then changing the level of each stereo channel according to the distance between the emitter and each ear by amplifying the difference between what the two ears hear.

fn play_spatial_audio_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play_spatial_with_settings(
        asset_server.load("my_sound.ogg"),
        PlaybackSettings::LOOP.with_volume(0.75),
        Transform::IDENTITY,
        1.0,
        Vec3::new(-2.0, 0.0, 1.0),
    );
}

See Self::play_spatial on how to control playback once it’s started, or how to move the listener or the emitter.

Trait Implementations

impl<Source> Debug for Audio<Source>where Source: Asset + Decodable,

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

Formats the value using the given formatter.

impl<Source> Default for Audio<Source>where Source: Asset + Decodable,

fn default() -> Audio<Source>

Returns the “default value” for a type.

impl<Source> Resource for Audio<Source>where Source: Asset + Decodable, Audio<Source>: Send + Sync + 'static,