audionimbus 0.14.0

A safe wrapper around Steam Audio that provides spatial audio capabilities with realistic occlusion, reverb, and HRTF effects, accounting for physical attributes and scene geometry.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! Convenient re-exports of commonly used types and traits.
//!
//! This prelude intentionally shadows types with aliases bound to [`DefaultSimulationConfiguration`].
//! Import the corresponding items from their defining modules when you need a custom
//! [`SimulationConfiguration`].
//!
//! It also re-exports a curated set of core AudioNimbus types that are commonly paired with the
//! Bevy integration.

use super::{
    asset, configuration, debug, error, geometry, hrtf, plugin, probe, runner, simulation, source,
    system_set,
};

pub use crate::audio_buffer::{AudioBuffer, AudioBufferSettings, Sample, num_ambisonics_channels};
pub use crate::audio_settings::AudioSettings;
pub use crate::context::Context;
pub use crate::effect::ambisonics::SpeakerLayout;
pub use crate::effect::ambisonics::decode::{
    AmbisonicsDecodeEffect, AmbisonicsDecodeEffectParams, AmbisonicsDecodeEffectSettings, Rendering,
};
pub use crate::effect::binaural::{BinauralEffect, BinauralEffectParams, BinauralEffectSettings};
pub use crate::effect::direct::{DirectEffect, DirectEffectParams, DirectEffectSettings};
pub use crate::effect::reflections::{
    Convolution, ReflectionEffect, ReflectionEffectParams, ReflectionEffectSettings,
};
pub use crate::geometry::{CoordinateSystem, Direction};
pub use crate::hrtf::{HrtfInterpolation, HrtfSettings};
pub use crate::simulation::{
    ConvolutionSettings, DirectSimulationSettings, ReflectionsSharedInputs, SimulationSettings,
};
pub use crate::wiring::{ReflectionsReverbOutput, SharedSimulationOutput};

pub use asset::{
    ProbeBatchAsset, ProbeBatchAssetLoader, ProbeBatchAssetSource, SceneAsset, SceneAssetLoader,
};
pub use configuration::*;
pub use debug::{SpatialAudioDebugPlugin, WireframeColor, WireframePalette};
pub use error::*;
pub use geometry::{InstancedMesh, MainScene, StaticMesh, SubSceneOf};
pub use hrtf::*;
pub use plugin::SpatialAudioPlugin;
pub use probe::*;
pub use runner::{
    Runner, RunnerDirect, RunnerPathing, RunnerReflections, RunnerReflectionsReverb, Spawn,
    SyncFrame, ToRunner,
};
pub use simulation::*;
pub use source::{Listener, on_source_added, on_source_removed};
pub use system_set::*;

/// Default-configuration alias for [`asset::SceneAssetSource`].
///
/// Import [`asset::SceneAssetSource`] directly when you need a custom [`SimulationConfiguration`].
pub type SceneAssetSource = asset::SceneAssetSource<configuration::DefaultSimulationConfiguration>;

/// Default-configuration alias for [`geometry::Scene`].
///
/// Import [`geometry::Scene`] directly when you need a custom [`SimulationConfiguration`].
pub type Scene = geometry::Scene<configuration::DefaultSimulationConfiguration>;

/// Default-configuration alias for [`source::Source`].
///
/// Import [`source::Source`] directly when you need a custom [`SimulationConfiguration`].
pub type Source = source::Source<configuration::DefaultSimulationConfiguration>;

/// Default-configuration alias for [`source::SourceParameters`].
///
/// Import [`source::SourceParameters`] directly when you need a custom [`SimulationConfiguration`].
pub type SourceParameters = source::SourceParameters<configuration::DefaultSimulationConfiguration>;

/// Default-configuration alias for [`runner::DirectSimulation`].
///
/// Import [`runner::DirectSimulation`] directly when you need a custom [`SimulationConfiguration`].
pub type DirectSimulation = runner::DirectSimulation<configuration::DefaultSimulationConfiguration>;

/// Default-configuration alias for [`runner::ReflectionsSimulation`].
///
/// Import [`runner::ReflectionsSimulation`] directly when you need a custom
/// [`SimulationConfiguration`].
pub type ReflectionsSimulation =
    runner::ReflectionsSimulation<configuration::DefaultSimulationConfiguration>;

/// Default-configuration alias for [`runner::ReflectionsReverbSimulation`].
///
/// Import [`runner::ReflectionsReverbSimulation`] directly when you need a custom
/// [`SimulationConfiguration`].
pub type ReflectionsReverbSimulation =
    runner::ReflectionsReverbSimulation<configuration::DefaultSimulationConfiguration>;

/// Default-configuration alias for [`runner::PathingSimulation`].
///
/// Import [`runner::PathingSimulation`] directly when you need a custom [`SimulationConfiguration`].
pub type PathingSimulation =
    runner::PathingSimulation<configuration::DefaultSimulationConfiguration>;