bevy_seedling 0.7.2

A sprouting integration of the Firewheel audio engine
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

[![crates.io](https://img.shields.io/crates/v/bevy_seedling)](https://crates.io/crates/bevy_seedling)
[![docs.rs](https://docs.rs/bevy_seedling/badge.svg)](https://docs.rs/bevy_seedling)

A sprouting integration of the [Firewheel](https://github.com/BillyDM/firewheel)
audio engine for [Bevy](https://bevyengine.org/).

`bevy_seedling` is powerful, flexible, and
[fast](https://github.com/CorvusPrudens/rust-audio-demo?tab=readme-ov-file#performance).
You can play sounds, apply effects,
and route audio anywhere. Creating
and integrating custom audio processors
is simple.

## Getting started

First, you'll need to add the dependency to your `Cargo.toml`.
Note that you'll need to disable Bevy's `bevy_audio` feature,
meaning you'll need to specify quite a few features
manually!

<details>
<summary>Example `Cargo.toml`</summary>

```toml
[dependencies]
bevy_seedling = "0.7.2"
bevy = { version = "0.18.0", default-features = false, features = [
  # 2d
  "2d_bevy_render",
  "default_app",
  "picking",
  "scene",

  # 3d
  "3d_bevy_render",

  # ui
  "ui_api",
  "ui_bevy_render",

  # default_platform
  "android-game-activity",
  "bevy_gilrs",
  "bevy_winit",
  "default_font",
  "multi_threaded",
  "std",
  "sysinfo_plugin",
  "wayland",
  "webgl2",
  "x11",
] }
```

</details>

Then, you'll need to add the `SeedlingPlugin` to your app.

```rs
use bevy::prelude::*;
use bevy_seedling::prelude::*;

fn main() {
    App::default()
        .add_plugins((DefaultPlugins, SeedlingPlugin::default()))
        .run();
}
```

Once you've set it all up, playing sounds is easy!

```rs
fn play_sound(mut commands: Commands, server: Res<AssetServer>) {
    // Play a sound!
    commands.spawn(SamplePlayer::new(server.load("my_sample.wav")));

    // Play a sound... with effects :O
    commands.spawn((
        SamplePlayer::new(server.load("my_ambience.wav")).looping(),
        sample_effects![LowPassNode { frequency: 500.0 }],
    ));
}
```

[The crate docs](https://docs.rs/bevy_seedling/latest) provide an overview of
`bevy_seedling`'s features, and
[the repository's examples](https://github.com/CorvusPrudens/bevy_seedling/tree/master/examples)
should help you get up to speed on common usage patterns.

## Feature flags

| Flag              | Description                                | Default |
| ----------------- | ------------------------------------------ | ------- |
| `reflect`         | Enable `bevy_reflect` derive macros.       | Yes     |
| `rand`            | Enable the `RandomPitch` component.        | Yes     |
| `wav`             | Enable WAV format and PCM encoding.        | Yes     |
| `ogg`             | Enable Ogg format and Vorbis encoding.     | Yes     |
| `mp3`             | Enable mp3 format and encoding.            | No      |
| `mkv`             | Enable mkv format.                         | No      |
| `adpcm`           | Enable adpcm encoding.                     | No      |
| `flac`            | Enable FLAC format and encoding.           | No      |
| `web_audio`       | Enable the multi-threading web backend.    | No      |
| `hrtf`            | Enable HRTF Spatialization.                | No      |
| `hrtf_subjects`   | Enable all HRTF embedded data.             | No      |
| `loudness`        | Enable LUFS analyzer node.                 | No      |
| `stream`          | Enable CPAL input and output stream nodes. | No      |
| `resample_inputs` | Enable audio input resampling.             | No      |
| `dev`             | Enable helpful features for development.   | No      |
| `entity_names`    | Add `Name`s to node and sample entities.   | No      |

## Bevy version compatibility

| `bevy` | `bevy_seedling` |
| ------ | --------------- |
| 0.18   | 0.7             |
| 0.17   | 0.6             |
| 0.16   | 0.4, 0.5        |
| 0.15   | 0.3             |

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>