Crate bevy_kira_audio
source ·Expand description
Audio plugin for the game engine Bevy
It uses the library Kira to play audio and offers an API to control running game audio via Bevy’s ECS.
use bevy_kira_audio::prelude::*;
use bevy::prelude::*;
fn main() {
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(AudioPlugin)
.add_systems(Startup, start_background_audio)
.run();
}
fn start_background_audio(asset_server: Res<AssetServer>, audio: Res<Audio>) {
audio.play(asset_server.load("background_audio.mp3")).looped();
}
Modules
- Most commonly used types
Structs
- Channel to play and control audio
- Asset for direct audio control
- A Bevy plugin for audio
- This resource is used to configure the audio backend at creation
- A source of audio data
- A tween for audio transitions
- A dynamic channel to play and control audio
- Resource to play and control audio in dynamic channels
- Marker trait for tween commands that are fading in.
- Marker trait for tween commands that are fading out.
- Type for the default audio channel
- A command for interacting with playing sound.
- A command for interacting with the tweening of the playing sound.
Enums
- Labels for audio systems
- Playback status of a currently playing sound.
Traits
- Extension trait to add new audio channels to the application
- Play and control audio
- Extension trait to remove some boilerplate when
Type Aliases
- The default audio channel
- Different kinds of easing for fade-in and fade-out