334e09892b
This reverts commit 53d387f340.
# Objective
Reverts #6448. This didn't have the intended effect: we're now getting bevy::prelude shown in the docs again.
Co-authored-by: Alejandro Pascual <alejandro.pascual.pozo@gmail.com>
66 lines
1.8 KiB
Rust
66 lines
1.8 KiB
Rust
//! Audio support for the game engine Bevy
|
|
//!
|
|
//! ```no_run
|
|
//! # use bevy_ecs::{system::Res, event::EventWriter};
|
|
//! # use bevy_audio::{Audio, AudioPlugin};
|
|
//! # use bevy_asset::{AssetPlugin, AssetServer};
|
|
//! # use bevy_app::{App, AppExit, NoopPluginGroup as MinimalPlugins};
|
|
//! fn main() {
|
|
//! App::new()
|
|
//! .add_plugins(MinimalPlugins)
|
|
//! .add_plugin(AssetPlugin::default())
|
|
//! .add_plugin(AudioPlugin)
|
|
//! .add_startup_system(play_background_audio)
|
|
//! .run();
|
|
//! }
|
|
//!
|
|
//! fn play_background_audio(asset_server: Res<AssetServer>, audio: Res<Audio>) {
|
|
//! audio.play(asset_server.load("background_audio.ogg"));
|
|
//! }
|
|
//! ```
|
|
|
|
#![forbid(unsafe_code)]
|
|
#![warn(missing_docs)]
|
|
|
|
mod audio;
|
|
mod audio_output;
|
|
mod audio_source;
|
|
|
|
#[allow(missing_docs)]
|
|
pub mod prelude {
|
|
#[doc(hidden)]
|
|
pub use crate::{Audio, AudioOutput, AudioSource, Decodable, PlaybackSettings};
|
|
}
|
|
|
|
pub use audio::*;
|
|
pub use audio_output::*;
|
|
pub use audio_source::*;
|
|
pub use rodio::cpal::Sample as CpalSample;
|
|
pub use rodio::source::Source;
|
|
pub use rodio::Sample;
|
|
|
|
use bevy_app::prelude::*;
|
|
use bevy_asset::AddAsset;
|
|
|
|
/// Adds support for audio playback to a Bevy Application
|
|
///
|
|
/// Use the [`Audio`] resource to play audio.
|
|
#[derive(Default)]
|
|
pub struct AudioPlugin;
|
|
|
|
impl Plugin for AudioPlugin {
|
|
fn build(&self, app: &mut App) {
|
|
app.init_non_send_resource::<AudioOutput<AudioSource>>()
|
|
.add_asset::<AudioSource>()
|
|
.add_asset::<AudioSink>()
|
|
.init_resource::<Audio<AudioSource>>()
|
|
.add_system_to_stage(
|
|
CoreStage::PostUpdate,
|
|
play_queued_audio_system::<AudioSource>,
|
|
);
|
|
|
|
#[cfg(any(feature = "mp3", feature = "flac", feature = "wav", feature = "vorbis"))]
|
|
app.init_asset_loader::<AudioLoader>();
|
|
}
|
|
}
|