Crate bevy_audio

Audio support for the game engine Bevy

fn main() {
   App::new()
        .add_plugins((MinimalPlugins, AssetPlugin::default(), AudioPlugin::default()))
        .add_systems(Startup, play_background_audio)
        .run();
}

fn play_background_audio(asset_server: Res<AssetServer>, mut commands: Commands) {
    commands.spawn(AudioBundle {
        source: asset_server.load("background_audio.ogg"),
        settings: PlaybackSettings::LOOP,
    });
}

Modules

• prelude

Structs

• AudioLoader
  Loads files as AudioSource Assets
• AudioPlugin
  Adds support for audio playback to a Bevy Application
• AudioSink
  Used to control audio during playback.
• AudioSource
  A source of audio data
• AudioSourceBundle
  Bundle for playing a sound.
• DefaultSpatialScale
  The default scale factor applied to the positions of audio sources and listeners for spatial audio. Can be overridden for individual sounds in PlaybackSettings.
• GlobalVolume
  Use this Resource to control the global volume of all audio.
• Pitch
  A source of sine wave sound
• PlaybackSettings
  Initial settings to be used when audio starts playing. If you would like to control the audio while it is playing, query for the AudioSink or SpatialAudioSink components. Changes to this component will not be applied to already-playing audio.
• SpatialAudioSink
  Used to control spatial audio during playback.
• SpatialListener
  Settings for the listener for spatial audio sources.
• SpatialScale
  A scale factor applied to the positions of audio sources and listeners for spatial audio.
• Volume
  A volume level equivalent to a non-negative float.

Enums

• PlaybackMode
  The way Bevy manages the sound playback.

Traits

• AddAudioSource
  A trait that allows adding a custom audio source to the object. This is implemented for App to allow registering custom Decodable types.
• AudioSinkPlayback
  Common interactions with an audio sink.
• CpalSample
  A trait for working generically across different Sample format types.
• Decodable
  A type implementing this trait can be converted to a rodio::Source type. It must be Send and Sync in order to be registered. Types that implement this trait usually contain raw sound data that can be converted into an iterator of samples. This trait is implemented for AudioSource. Check the example decodable for how to implement this trait on a custom type.
• Sample
  Represents a value of a single sample.
• Source
  A source of samples.

Type Aliases

• AudioBundle
  Bundle for playing a standard bevy audio asset
• PitchBundle
  Bundle for playing a bevy note sound