Bevy Kira Audio

https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/
Admin
Bevy Kira Audio is a Bevy game engine plugin that provides audio playback and control via the Kira...
Tokens:116,291
Snippets:1,399
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Configure Sound Start Time

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html?search=

Sets the start time for the sound playback. Returns a clone of StaticSoundData with the modified start time.

```rust
pub fn start_time(&self, start_time: impl Into<StartTime>) -> StaticSoundData
```

```rust
use kira::{
	AudioManager,
	AudioManagerSettings,
	DefaultBackend,
	sound::static_sound::{StaticSoundData, StaticSoundSettings},
	clock::ClockSpeed,
};

let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let clock_handle = manager.add_clock(ClockSpeed::TicksPerMinute(120.0))?;
let sound = StaticSoundData::from_file("sound.ogg")?
	.start_time(clock_handle.time() + 4);
```

--------------------------------

### SpatialAudioPlugin Search Examples

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioPlugin.html?search=

Provides examples of how to perform searches within the SpatialAudioPlugin. These examples demonstrate common search patterns and types.

```APIDOC
## Search Examples

### Description
Examples of search queries that can be performed.

### Example Searches
* `std::vec`
* `u32 -> bool`
* `Option<T>, (T -> U) -> Option<U>`
```

--------------------------------

### Plugin::finish Method

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioPlugin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Completes the plugin's setup after all other registered plugins are ready. Useful for plugins dependent on asynchronous setup from other plugins.

```rust
fn finish(&self, _app: &mut App)
```

--------------------------------

### StaticSoundSettings::start_time

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html

Sets the start time for the sound playback.

```APIDOC
## StaticSoundSettings::start_time

### Description
Sets when the sound should start playing.

### Method
Builder method

### Parameters
* `start_time` (impl Into<StartTime>) - The desired start time for the sound.

### Returns
An updated `StaticSoundSettings` instance with the start time set.
```

--------------------------------

### Set Start Time for Static Sound

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html?search=

Configures the start time for a static sound.

```rust
pub fn start_time(self, start_time: impl Into<StartTime>) -> StaticSoundSettings
```

--------------------------------

### Configure Sound Start Position

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html?search=

Sets the starting playback position within the sound. Returns a clone of StaticSoundData with the modified start position.

```rust
pub fn start_position( &self, start_position: impl Into<PlaybackPosition>, ) -> StaticSoundData
```

--------------------------------

### Plugin::ready Method

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioPlugin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Checks if the plugin has finished its setup. Useful for plugins with asynchronous initialization.

```rust
fn ready(&self, _app: &App) -> bool
```

--------------------------------

### Resume All Audio Example

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioChannel.html

Demonstrates how to resume all paused audio playback in the channel using the `resume` method.

```rust
fn my_system(audio: Res<Audio>) {
    audio.resume();
}
```

--------------------------------

### Adding AudioPlugin to Bevy App

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioPlugin.html

Demonstrates how to add the AudioPlugin to a Bevy application. This setup includes minimal plugins, asset handling, and a system for starting background audio.

```rust
fn main() {
   let mut app = App::new();
   app
        .add_plugins(MinimalPlugins)
        .add_plugins(AssetPlugin::default())
        .add_plugins(AudioPlugin)
        .add_systems(Startup, start_background_audio);
   app.run();
}

fn start_background_audio(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play(asset_server.load("background_audio.mp3")).looped();
}
```

--------------------------------

### Play Audio Example

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioChannel.html

Demonstrates how to play an audio file using the `play` method of the `Audio` resource. Ensure the audio file is loaded by the `AssetServer`.

```rust
fn my_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play(asset_server.load("audio.mp3"));
}
```

--------------------------------

### Set Volume Example

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioChannel.html

Shows how to set the volume for all audio in the channel using the `set_volume` method. Volume is specified in Decibels.

```rust
fn my_system(audio: Res<Audio>) {
    audio.set_volume(-6.);
}
```

--------------------------------

### Configure sound start time with a clock

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html

Sets the start time for a StaticSoundData using a clock handle. This returns a clone of the original data with the modified start time.

```rust
use kira::{
	AudioManager,
	AudioManagerSettings,
	DefaultBackend,
	sound::static_sound::{StaticSoundData, StaticSoundSettings},
	clock::ClockSpeed,
};

let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let clock_handle = manager.add_clock(ClockSpeed::TicksPerMinute(120.0))?;
let sound = StaticSoundData::from_file("sound.ogg")?
	.start_time(clock_handle.time() + 4);
```

--------------------------------

### Initialize Bevy App with AudioPlugin

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/index.html?search=

This snippet shows how to set up a Bevy application with the default plugins and the AudioPlugin. It also includes a system to start background audio on startup.

```rust
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();
}

```

--------------------------------

### StaticSoundData::start_time

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html

Sets the start time for the sound playback, returning a cloned StaticSoundData with the modified setting.

```APIDOC
## `StaticSoundData::start_time`

`pub fn start_time(&self, start_time: impl Into<StartTime>) -> StaticSoundData`

Sets when the sound should start playing. This returns a cheap clone of the `StaticSoundData` with the modified start time.

### Examples

Configuring a sound to start 4 ticks after a clock’s current time:
```rust
use kira::sound::static_sound::StaticSoundData;

// Assuming clock_handle is available and represents the current time
// let sound = StaticSoundData::from_file("sound.ogg")?.start_time(clock_handle.time() + 4);
```
```

--------------------------------

### Pause All Audio Example

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioChannel.html

Illustrates how to pause all audio playback in the channel using the `pause` method.

```rust
fn my_system(audio: Res<Audio>) {
    audio.pause();
}
```

--------------------------------

### Handle Start of Audio Processing

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/trait.Sound.html

The `on_start_processing` method is invoked when the audio backend requests a new batch of samples. It's suitable for frequent, but not per-sample, operations.

```rust
fn on_start_processing(&mut self) { ... }

```

--------------------------------

### StaticSoundSettings::start_position

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Sets the starting playback position for the sound.

```APIDOC
## StaticSoundSettings::start_position

### Description
Sets where in the sound playback should start.

### Parameters
- `start_position` (impl Into<PlaybackPosition>): The desired start position for playback.

### Returns
A modified `StaticSoundSettings` instance with the updated start position.
```

--------------------------------

### StaticSoundSettings::start_position

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html

Sets the starting playback position for the sound.

```APIDOC
## StaticSoundSettings::start_position

### Description
Sets where in the sound playback should start.

### Method
Builder method

### Parameters
* `start_position` (impl Into<PlaybackPosition>) - The desired start position for playback.

### Returns
An updated `StaticSoundSettings` instance with the start position set.
```

--------------------------------

### Set Start Position for Static Sound

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html?search=

Specifies the starting playback position for a static sound.

```rust
pub fn start_position(
    self,
    start_position: impl Into<PlaybackPosition>,
) -> StaticSoundSettings
```

--------------------------------

### Stop All Audio Example

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioChannel.html

Shows how to stop all currently playing audio in the channel using the `stop` method.

```rust
fn my_system(audio: Res<Audio>) {
    audio.stop();
}
```

--------------------------------

### Setting Loop Start Position with PlayAudioCommand

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.PlayAudioCommand.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Sets the starting position for the loop in seconds. This method modifies the command in place and returns a mutable reference to self.

```rust
pub fn loop_from(&mut self, loop_start_position: f64) -> &mut Self
```

--------------------------------

### Looping with Specific Start and End Points

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.PlayAudioCommand.html?search=

Configure a sound to loop between specified start and end times in seconds. Ideal for looping music or specific sound segments.

```rust
pub fn loop_from(&mut self, loop_start_position: f64) -> &mut Self
```

```rust
pub fn loop_until(&mut self, loop_end_position: f64) -> &mut Self
```

--------------------------------

### Set Panning Example

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioChannel.html

Illustrates how to adjust the stereo panning for all audio in the channel using the `set_panning` method. Values range from -1.0 (left) to 1.0 (right).

```rust
fn my_system(audio: Res<Audio>) {
    audio.set_panning(0.9);
}
```

--------------------------------

### state

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/trait.AudioControl.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the playback state for a specific audio instance handle.

```APIDOC
## state

### Description
Get state for a playback instance.

### Method
`state`

### Parameters
* `instance_handle`: `&Handle<AudioInstance>` - A reference to the handle of the audio instance.

### Returns
`PlaybackState`
```

--------------------------------

### Starting Sound from a Specific Position

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.PlayAudioCommand.html?search=

Begins sound playback from a specified time in seconds. Useful for seeking within audio files.

```rust
pub fn start_from(&mut self, start_position: f64) -> &mut Self
```

--------------------------------

### Set Playback Rate Example

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioChannel.html

Demonstrates how to change the playback speed for all audio in the channel using the `set_playback_rate` method. The default value is 1.0.

```rust
fn my_system(audio: Res<Audio>) {
    audio.set_playback_rate(2.0);
}
```

--------------------------------

### Start Sound Paused

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.PlayAudioCommand.html?search=

Initiates sound playback in a paused state. Useful for pre-loading sounds without immediate playback.

```rust
pub fn paused(&mut self) -> &mut Self
```

--------------------------------

### StaticSoundData::start_position

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html

Sets the starting playback position within the sound, returning a cloned StaticSoundData with the modified setting.

```APIDOC
## `StaticSoundData::start_position`

`pub fn start_position( &self, start_position: impl Into<PlaybackPosition>, ) -> StaticSoundData`

Sets where in the sound playback should start. This returns a cheap clone of the `StaticSoundData` with the modified start position.
```

--------------------------------

### Add Audio Channel to Bevy App

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/trait.AudioApp.html?search=

Demonstrates how to add a custom audio channel (e.g., Background) to a Bevy application using the AudioApp trait. This setup involves initializing Bevy, the AudioPlugin, and defining systems to play audio on the new channel.

```rust
use bevy::prelude::*;
use bevy_kira_audio::prelude::*;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(AudioPlugin)
        .add_audio_channel::<Background>()
        .add_systems(Startup, play)
        .run();
}

fn play(background: Res<AudioChannel<Background>>, asset_server: Res<AssetServer>) {
    background.play(asset_server.load("sounds/loop.ogg"));
}

#[derive(Resource)]
struct Background;

```

--------------------------------

### Get Audio Instance Handle

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.PlayAudioCommand.html?search=

Retrieves a handle to the underlying `AudioInstance`. This handle can be used for further control or querying of the playing sound.

```rust
pub fn handle(&mut self) -> Handle<AudioInstance>
```

--------------------------------

### Get a Dynamic Audio Channel (Panics on Not Found)

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.DynamicAudioChannels.html

Retrieves a reference to the audio channel for the given key. This method will panic if no channel exists for the key. Use `get_channel` if you need to handle cases where the channel might not exist.

```rust
pub fn channel(&self, key: &str) -> &DynamicAudioChannel
```

--------------------------------

### Prelude Module Overview

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/index.html?search=

This section details the core components available in the prelude module for audio handling.

```APIDOC
## Module prelude

This module contains the most commonly used types for audio manipulation within the bevy_kira_audio library.

### Structs

- **Decibels**: Represents a change in volume.
- **Frame**: Represents a stereo audio sample.
- **StaticSoundData**: Represents a piece of audio loaded into memory all at once.
- **StaticSoundSettings**: Contains settings for a static sound.

### Enums

- **FromFileError**: Enumerates the possible errors that can occur when loading or streaming an audio file.

### Traits

- **Sound**: Represents an actively playing sound.
- **SoundData**: Represents a source of audio that is loaded but not yet playing.
```

--------------------------------

### IntoScheduleConfigs<Interned<dyn SystemSet>, ()>

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.AudioSystemSet.html

Provides methods to configure how systems are scheduled, including setting dependencies, run conditions, and handling ambiguities.

```APIDOC
## into_configs

### Description
Converts into a `ScheduleConfigs`.

### Method
`into_configs()`

## in_set

### Description
Add these systems to the provided `set`.

### Method
`in_set(set: impl SystemSet)`

## before

### Description
Runs before all systems in `set`. If `self` has any systems that produce `Commands` or other `Deferred` operations, all systems in `set` will see their effect.

### Method
`before<M>(set: impl IntoSystemSet<M>)`

## after

### Description
Runs after all systems in `set`. If `set` has any systems that produce `Commands` or other `Deferred` operations, all systems in `self` will see their effect.

### Method
`after<M>(set: impl IntoSystemSet<M>)`

## before_ignore_deferred

### Description
Runs before all systems in `set`.

### Method
`before_ignore_deferred<M>(set: impl IntoSystemSet<M>)`

## after_ignore_deferred

### Description
Runs after all systems in `set`.

### Method
`after_ignore_deferred<M>(set: impl IntoSystemSet<M>)`

## distributive_run_if

### Description
Add a run condition to each contained system.

### Method
`distributive_run_if<M>(condition: impl SystemCondition<M> + Clone)`

## run_if

### Description
Run the systems only if the `SystemCondition` is `true`.

### Method
`run_if<M>(condition: impl SystemCondition<M>)`

## ambiguous_with

### Description
Suppress warnings and errors that would result from these systems having ambiguities (conflicting access but indeterminate order) with systems in `set`.

### Method
`ambiguous_with<M>(set: impl IntoSystemSet<M>)`

## ambiguous_with_all

### Description
Suppress warnings and errors that would result from these systems having ambiguities (conflicting access but indeterminate order) with any other system.

### Method
`ambiguous_with_all()`

## chain

### Description
Treat this collection as a sequence of systems.

### Method
`chain()`

## chain_ignore_deferred

### Description
Treat this collection as a sequence of systems.

### Method
`chain_ignore_deferred()`
```

--------------------------------

### StaticSoundSettings::new

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html

Creates a new StaticSoundSettings instance with default values.

```APIDOC
## StaticSoundSettings::new

### Description
Creates a new `StaticSoundSettings` with the default settings.

### Method
Associated function (constructor-like)

### Returns
A new `StaticSoundSettings` instance.
```

--------------------------------

### Equivalent<K> for Q

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.AudioSystemSet.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Compares the current system set with a given key to determine equality. Returns true if they are equal, false otherwise.

```APIDOC
## fn equivalent(&self, key: &K) -> bool

### Description
Compare self to `key` and return `true` if they are equal.

### Method
`equivalent`

### Parameters
#### Path Parameters
- **key** (*&K*) - Required - The key to compare against.

### Response
#### Success Response (bool)
- **true** - If the system set is equal to the key.
- **false** - If the system set is not equal to the key.
```

--------------------------------

### StaticSoundHandle

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html?search=u32+-%3E+bool

The Handle type used to control a sound once it has started playing.

```APIDOC
#### type Handle = StaticSoundHandle
The type that can be used to control the sound once it has started.
```

--------------------------------

### with_settings

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html

Returns a clone of the StaticSoundData with the specified settings.

```APIDOC
## with_settings

### Description
Returns a cheap clone of the `StaticSoundData` with the specified settings.

### Method
This is a method on the `StaticSoundData` struct.

### Parameters
- **settings**: `StaticSoundSettings` - The settings to apply to the `StaticSoundData`.
```

--------------------------------

### SpatialAudioEmitter On Despawn Hook

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioEmitter.html?search=

Gets the on_despawn component hook for SpatialAudioEmitter if defined.

```rust
fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>
```

--------------------------------

### from_sample_

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.Frame.html

Creates a sample from a given value.

```APIDOC
## fn from_sample_(s: S) -> S

### Description
Creates a sample from a given value.

### Method
`from_sample_`

### Parameters
- `s`: `S` - The value to create the sample from.

### Returns
- `S` - The created sample.
```

--------------------------------

### SpatialAudioEmitter On Remove Hook

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioEmitter.html?search=

Gets the on_remove component hook for SpatialAudioEmitter if defined.

```rust
fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>
```

--------------------------------

### SpatialAudioEmitter On Replace Hook

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioEmitter.html?search=

Gets the on_replace component hook for SpatialAudioEmitter if defined.

```rust
fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>
```

--------------------------------

### into_sample

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioSource.html?search=std%3A%3Avec

Converts the AudioSource into a sample type.

```APIDOC
## fn into_sample(self) -> T

### Description
Converts the `self` into a sample type `T`.

### Return Type
- **T** - The converted sample type.
```

--------------------------------

### SpatialAudioEmitter On Insert Hook

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioEmitter.html?search=

Gets the on_insert component hook for SpatialAudioEmitter if defined.

```rust
fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>
```

--------------------------------

### SpatialAudioEmitter On Add Hook

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioEmitter.html?search=

Gets the on_add component hook for SpatialAudioEmitter if defined.

```rust
fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>
```

--------------------------------

### Any Trait Implementation

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.PlaybackState.html?search=u32+-%3E+bool

Provides a way to get the TypeId of a trait object, useful for downcasting.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Equivalent

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.AudioSystemSet.html?search=std%3A%3Avec

Compares the current audio system set with a given key to check for equality. Returns true if they are equal, false otherwise.

```APIDOC
## fn equivalent(&self, key: &K) -> bool

### Description
Compare self to `key` and return `true` if they are equal.

### Method
N/A (Method on a trait implementation)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (bool)
- **true** (bool) - Indicates the audio system sets are equal.
- **false** (bool) - Indicates the audio system sets are not equal.

#### Response Example
N/A
```

--------------------------------

### SoundData Handle Associated Type

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/trait.SoundData.html?search=std%3A%3Avec

Specifies the type used to control a sound once it has started playing.

```rust
type Handle;
```

--------------------------------

### AudioInstance Methods

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioInstance.html?search=std%3A%3Avec

Provides methods for controlling audio playback, such as pausing, resuming, stopping, changing volume, playback rate, panning, and seeking.

```APIDOC
## AudioInstance

Asset for direct audio control.

### Methods

#### `pause(&mut self, tween: AudioTween)`
Pause the audio instance with the given easing.

#### `resume(&mut self, tween: AudioTween)`
Resume the audio instance with the given easing.

#### `stop(&mut self, tween: AudioTween)`
Stop the audio instance with the given easing.

#### `state(&self) -> PlaybackState`
Get the state of the audio instance.

#### `set_decibels(&mut self, volume: impl Into<Decibels>, tween: AudioTween)`
Change the volume of the audio instance. Higher values increase the volume and lower values decrease it. Setting the volume of a sound to -60dB or lower makes it silent.

#### `set_playback_rate(&mut self, playback_rate: f64, tween: AudioTween)`
Sets the playback rate of the sound. Changing the playback rate will change both the speed and pitch of the sound.

#### `set_panning(&mut self, panning: f32, tween: AudioTween)`
Sets the panning of the sound. `1.0` is hard right, `0.0` is center (default), `-1.0` is hard left.

#### `seek_to(&mut self, position: f64)`
Sets the playback position to the specified time in seconds.

#### `seek_by(&mut self, amount: f64)`
Moves the playback position by the specified amount of time in seconds.
```

--------------------------------

### SoundData Error Associated Type

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/trait.SoundData.html?search=std%3A%3Avec

Specifies the type that represents errors that can occur when starting a sound.

```rust
type Error;
```

--------------------------------

### System Set Conversion and Configuration

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.AudioSystemSet.html?search=

Provides methods for converting system sets into different formats, configuring their execution order, and applying run conditions.

```APIDOC
## System Set Operations

### Description
This section covers various methods for manipulating and configuring system sets, including conversions, ordering, and conditional execution.

### Methods

#### `into_configs(self) -> ScheduleConfigs<Interned<dyn SystemSet>>`
Converts the system set into `ScheduleConfigs`.

#### `in_set(self, set: impl SystemSet) -> ScheduleConfigs<T>`
Adds the systems from this set to the provided `set`.

#### `before<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>`
Ensures that the systems in this set run before all systems in the specified `set`.

#### `after<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>`
Ensures that the systems in this set run after all systems in the specified `set`.

#### `before_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>`
Runs before all systems in `set`, ignoring deferred operations.

#### `after_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>`
Runs after all systems in `set`, ignoring deferred operations.

#### `distributive_run_if<M>(self, condition: impl SystemCondition<M> + Clone) -> ScheduleConfigs<T>`
Adds a run condition to each contained system, making them run distributively if the condition is met.

#### `run_if<M>(self, condition: impl SystemCondition<M>) -> ScheduleConfigs<T>`
Runs the systems only if the provided `SystemCondition` evaluates to `true`.

#### `ambiguous_with<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>`
Suppresses warnings and errors related to ambiguous system ordering with systems in the specified `set`.

#### `ambiguous_with_all(self) -> ScheduleConfigs<T>`
Suppresses all warnings and errors related to ambiguous system ordering.

#### `chain(self) -> ScheduleConfigs<T>`
Treats this collection of systems as a sequential chain.

#### `chain_ignore_deferred(self) -> ScheduleConfigs<T>`
Treats this collection of systems as a sequential chain, ignoring deferred operations.

### Parameters
- `set`: An object that can be converted into a `SystemSet`.
- `condition`: A `SystemCondition` that determines if systems should run.

### Response
Returns `ScheduleConfigs<T>` which allows for further configuration of the system schedule.
```

--------------------------------

### state

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/trait.AudioControl.html?search=

Gets the playback state for a specific audio instance. This method requires a Handle to an AudioInstance.

```APIDOC
## fn state(&self, instance_handle: &Handle<AudioInstance>) -> PlaybackState

### Description
Get state for a playback instance.

### Parameters
#### Path Parameters
- **instance_handle** (&Handle<AudioInstance>) - Required - A handle to the audio instance.
```

--------------------------------

### IntoScheduleConfigs<Interned<dyn SystemSet>, ()> for S

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.AudioSystemSet.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides methods to configure how systems within a set are scheduled, including ordering, conditions, and ambiguity handling.

```APIDOC
## fn into_configs(self) -> ScheduleConfigs<Interned<dyn SystemSet>>

### Description
Convert into a `ScheduleConfigs`.

### Method
`into_configs`

### Response
#### Success Response (ScheduleConfigs<Interned<dyn SystemSet>>)
- **ScheduleConfigs<Interned<dyn SystemSet>>** - The schedule configurations.
```

```APIDOC
## fn in_set(self, set: impl SystemSet) -> ScheduleConfigs<T>

### Description
Add these systems to the provided `set`.

### Method
`in_set`

### Parameters
#### Path Parameters
- **set** (*impl SystemSet*) - Required - The system set to add these systems to.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations.
```

```APIDOC
## fn before<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>

### Description
Runs before all systems in `set`. If `self` has any systems that produce `Commands` or other `Deferred` operations, all systems in `set` will see their effect.

### Method
`before`

### Parameters
#### Path Parameters
- **set** (*impl IntoSystemSet<M>*) - Required - The system set to run before.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations.
```

```APIDOC
## fn after<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>

### Description
Runs after all systems in `set`. If `set` has any systems that produce `Commands` or other `Deferred` operations, all systems in `self` will see their effect.

### Method
`after`

### Parameters
#### Path Parameters
- **set** (*impl IntoSystemSet<M>*) - Required - The system set to run after.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations.
```

```APIDOC
## fn before_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>

### Description
Runs before all systems in `set`.

### Method
`before_ignore_deferred`

### Parameters
#### Path Parameters
- **set** (*impl IntoSystemSet<M>*) - Required - The system set to run before, ignoring deferred operations.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations.
```

```APIDOC
## fn after_ignore_deferred<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>

### Description
Runs after all systems in `set`.

### Method
`after_ignore_deferred`

### Parameters
#### Path Parameters
- **set** (*impl IntoSystemSet<M>*) - Required - The system set to run after, ignoring deferred operations.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations.
```

```APIDOC
## fn distributive_run_if<M>(self, condition: impl SystemCondition<M> + Clone) -> ScheduleConfigs<T>

### Description
Adds a run condition to each contained system.

### Method
`distributive_run_if`

### Parameters
#### Path Parameters
- **condition** (*impl SystemCondition<M> + Clone*) - Required - The system condition to apply.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations with the run condition applied.
```

```APIDOC
## fn run_if<M>(self, condition: impl SystemCondition<M>) -> ScheduleConfigs<T>

### Description
Runs the systems only if the `SystemCondition` is `true`.

### Method
`run_if`

### Parameters
#### Path Parameters
- **condition** (*impl SystemCondition<M>*) - Required - The system condition to check.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations with the run condition.
```

```APIDOC
## fn ambiguous_with<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>

### Description
Suppresses warnings and errors that would result from these systems having ambiguities (conflicting access but indeterminate order) with systems in `set`.

### Method
`ambiguous_with`

### Parameters
#### Path Parameters
- **set** (*impl IntoSystemSet<M>*) - Required - The system set to check for ambiguities with.

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations with ambiguity suppression.
```

```APIDOC
## fn ambiguous_with_all(self) -> ScheduleConfigs<T>

### Description
Suppresses warnings and errors that would result from these systems having ambiguities (conflicting access but indeterminate order) with any other system.

### Method
`ambiguous_with_all`

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The updated schedule configurations with all ambiguity suppression.
```

```APIDOC
## fn chain(self) -> ScheduleConfigs<T>

### Description
Treats this collection as a sequence of systems.

### Method
`chain`

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The schedule configurations representing a chained sequence of systems.
```

```APIDOC
## fn chain_ignore_deferred(self) -> ScheduleConfigs<T>

### Description
Treats this collection as a sequence of systems, ignoring deferred operations.

### Method
`chain_ignore_deferred`

### Response
#### Success Response (ScheduleConfigs<T>)
- **ScheduleConfigs<T>** - The schedule configurations representing a chained sequence of systems, ignoring deferred operations.
```

--------------------------------

### state

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/trait.AudioControl.html?search=u32+-%3E+bool

Gets the playback state for a specific audio instance. This method requires a Handle to an AudioInstance.

```APIDOC
## state

### Description
Get state for a playback instance.

### Method
`state`

### Parameters
- `instance_handle`: `&Handle<AudioInstance>` - A handle to the audio instance.

### Returns
`PlaybackState` - The current playback state of the audio instance.
```

--------------------------------

### Create New StaticSoundSettings

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html?search=

Initializes a new StaticSoundSettings instance with default values.

```rust
pub fn new() -> StaticSoundSettings
```

--------------------------------

### DynamicBundle

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialRadius.html?search=std%3A%3Avec

Provides methods for handling dynamic bundles of components, including getting and applying effects.

```APIDOC
## DynamicBundle

### Description
Represents a dynamic bundle of components. It defines an `Effect` type and methods to get and apply these effects.

#### Type `Effect`
An operation on the entity that happens _after_ inserting this bundle.

#### `unsafe fn get_components`
Moves the components out of the bundle.

#### `unsafe fn apply_effect`
Applies the after-effects of spawning this bundle.
```

--------------------------------

### into_sample

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioTween.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts the input type into a sample type.

```APIDOC
## fn into_sample(self) -> T

### Description
Converts the input type into a sample type.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
Not applicable (method call)

### Endpoint
Not applicable (method call)

### Request Example
Not applicable (method call)

### Response
#### Success Response
- **T** - The sample type.
```

--------------------------------

### Get Type ID of Decibels

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.Decibels.html

Retrieves the `TypeId` of the Decibels struct. This is part of the `Any` trait implementation.

```rust
fn type_id(&self) -> TypeId;

```

--------------------------------

### into_sample

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioSource.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts the audio source into a sample type T, where T implements FromSample<F>.

```APIDOC
## into_sample

### Description
Converts the audio source into a sample type T.

### Method
`into_sample() -> T`

### Type Parameters
* `T`: The target sample type, which must implement `FromSample<F>`.
```

--------------------------------

### To Sample

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.PlaybackState.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts the type into a sample type.

```APIDOC
## fn to_sample_(self) -> U

Converts the type into a sample type.
```

--------------------------------

### AudioInstance Methods

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioInstance.html?search=u32+-%3E+bool

Provides methods for direct manipulation of audio playback, such as pausing, resuming, stopping, and adjusting playback properties.

```APIDOC
## AudioInstance

Asset for direct audio control

### Methods

#### `pause(&mut self, tween: AudioTween)`

Pause the audio instance with the given easing.

#### `resume(&mut self, tween: AudioTween)`

Resume the audio instance with the given easing.

#### `stop(&mut self, tween: AudioTween)`

Stop the audio instance with the given easing.

#### `state(&self) -> PlaybackState`

Get the state of the audio instance.

#### `set_decibels(&mut self, volume: impl Into<Decibels>, tween: AudioTween)`

Change the volume of the audio instance. Higher values increase the volume and lower values decrease it. Setting the volume of a sound to -60dB or lower makes it silent.

#### `set_playback_rate(&mut self, playback_rate: f64, tween: AudioTween)`

Sets the playback rate of the sound. Changing the playback rate will change both the speed and pitch of the sound.

#### `set_panning(&mut self, panning: f32, tween: AudioTween)`

Sets the panning of the sound. `1.0` is hard right, `0.0` is center (default), `-1.0` is hard left.

#### `seek_to(&mut self, position: f64)`

Sets the playback position to the specified time in seconds.

#### `seek_by(&mut self, amount: f64)`

Moves the playback position by the specified amount of time in seconds.
```

--------------------------------

### SpatialAudioEmitter Bundle Get Component IDs

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioEmitter.html?search=

Returns an iterator over optional component IDs for the SpatialAudioEmitter bundle.

```rust
fn get_component_ids( components: &Components, ) -> impl Iterator<Item = Option<ComponentId>>
```

--------------------------------

### Into Sample

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.PlaybackState.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts the type into a sample type.

```APIDOC
## fn into_sample(self) -> T

Converts the type into a sample type.
```

--------------------------------

### AudioPlugin

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioPlugin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

A Bevy plugin for audio. Add this plugin to your Bevy app to get access to the Audio resource.

```APIDOC
## Struct AudioPlugin

### Description
A Bevy plugin for audio. Add this plugin to your Bevy app to get access to the Audio resource.

### Example Usage
```rust
fn main() {
   let mut app = App::new();
   app
        .add_plugins(MinimalPlugins)
        .add_plugins(AssetPlugin::default())
        .add_plugins(AudioPlugin)
        .add_systems(Startup, start_background_audio);
   app.run();
}

fn start_background_audio(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play(asset_server.load("background_audio.mp3")).looped();
}
```
```

--------------------------------

### Get &dyn Any from &Trait

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts a `&Trait` to `&Any`. This is necessary because Rust cannot generate `&Any`'s vtable from `&Trait`'s.

```rust
fn as_any(&self) -> &(dyn Any + 'static)
```

--------------------------------

### ToSample<U>::to_sample_

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioReceiver.html?search=std%3A%3Avec

Converts to a sample.

```APIDOC
## fn to_sample_(self) -> U

Converts to a sample.
```

--------------------------------

### Create and Slice StaticSoundData

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html

Demonstrates creating a StaticSoundData instance and then slicing it to represent a portion of the audio. The slice affects methods like `num_frames` and `frame_at_index`.

```rust
use kira::{
	sound::static_sound::{StaticSoundData, StaticSoundSettings},
	Frame,
};
let sound = StaticSoundData {
	sample_rate: 1,
	frames: (0..10).map(|i| Frame::from_mono(i as f32)).collect(),
	settings: StaticSoundSettings::default(),
	slice: None,
};
let sliced = sound.slice(3.0..6.0);
assert_eq!(sliced.num_frames(), 3);
assert_eq!(sliced.frame_at_index(0), Some(Frame::from_mono(3.0)));
assert_eq!(sliced.frame_at_index(1), Some(Frame::from_mono(4.0)));
```

--------------------------------

### into_sample

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/enum.FromFileError.html?search=

Converts the current type into a sample type `T`, where `T` must implement `FromSample<F>`.

```APIDOC
## into_sample

### Description
Converts the current type into a sample type `T`.

### Method Signature
`fn into_sample(self) -> T`
```

--------------------------------

### Get Playback Position

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/enum.PlaybackState.html?search=u32+-%3E+bool

Retrieves the current playback position in seconds for states that track it. Returns None if the state does not have a position.

```rust
pub fn position(&self) -> Option<f64>
```

--------------------------------

### AudioInstance Control Methods

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioInstance.html?search=

Provides methods to control the playback state, volume, playback rate, panning, and position of an audio instance.

```APIDOC
## AudioInstance Methods

### pause

Pause the audio instance with the given easing.

#### Parameters
* `tween` (AudioTween) - Description of easing for the pause operation.

### resume

Resume the audio instance with the given easing.

#### Parameters
* `tween` (AudioTween) - Description of easing for the resume operation.

### stop

Stop the audio instance with the given easing.

#### Parameters
* `tween` (AudioTween) - Description of easing for the stop operation.

### state

Get the state of the audio instance.

#### Returns
* `PlaybackState` - The current playback state of the audio instance.

### set_decibels

Change the volume of the audio instance.
Higher values increase the volume and lower values decrease it. Setting the volume of a sound to -60dB or lower makes it silent.

#### Parameters
* `volume` (impl Into<Decibels>) - The desired volume in decibels.
* `tween` (AudioTween) - Description of easing for the volume change.

### set_playback_rate

Sets the playback rate of the sound.
Changing the playback rate will change both the speed and pitch of the sound.

#### Parameters
* `playback_rate` (f64) - The desired playback rate.
* `tween` (AudioTween) - Description of easing for the playback rate change.

### set_panning

Sets the panning of the sound.
`1.0` is hard right, `0.0` is center (default), `-1.0` is hard left.

#### Parameters
* `panning` (f32) - The desired panning value.
* `tween` (AudioTween) - Description of easing for the panning change.

### seek_to

Sets the playback position to the specified time in seconds.

#### Parameters
* `position` (f64) - The target playback position in seconds.

### seek_by

Moves the playback position by the specified amount of time in seconds.

#### Parameters
* `amount` (f64) - The amount of time in seconds to move the playback position by.
```

--------------------------------

### AudioInstance Control Methods

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioInstance.html

This section details the methods available on the AudioInstance struct for direct audio control.

```APIDOC
## pause

### Description
Pauses the audio instance with the given easing.

### Method
`pause(&mut self, tween: AudioTween)`

### Parameters
- `tween`: `AudioTween` - The easing configuration for the pause operation.

## resume

### Description
Resumes the audio instance with the given easing.

### Method
`resume(&mut self, tween: AudioTween)`

### Parameters
- `tween`: `AudioTween` - The easing configuration for the resume operation.

## stop

### Description
Stops the audio instance with the given easing.

### Method
`stop(&mut self, tween: AudioTween)`

### Parameters
- `tween`: `AudioTween` - The easing configuration for the stop operation.

## state

### Description
Gets the current playback state of the audio instance.

### Method
`state(&self) -> PlaybackState`

### Returns
- `PlaybackState`: The current state of the audio instance.

## set_decibels

### Description
Changes the volume of the audio instance with the given easing. Higher values increase the volume and lower values decrease it. Setting the volume of a sound to -60dB or lower makes it silent.

### Method
`set_decibels(&mut self, volume: impl Into<Decibels>, tween: AudioTween)`

### Parameters
- `volume`: `impl Into<Decibels>` - The desired volume in decibels.
- `tween`: `AudioTween` - The easing configuration for the volume change.

## set_playback_rate

### Description
Sets the playback rate of the sound. Changing the playback rate will change both the speed and pitch of the sound.

### Method
`set_playback_rate(&mut self, playback_rate: f64, tween: AudioTween)`

### Parameters
- `playback_rate`: `f64` - The desired playback rate.
- `tween`: `AudioTween` - The easing configuration for the playback rate change.

## set_panning

### Description
Sets the panning of the sound. `1.0` is hard right, `0.0` is center (default), `-1.0` is hard left.

### Method
`set_panning(&mut self, panning: f32, tween: AudioTween)`

### Parameters
- `panning`: `f32` - The desired panning value.
- `tween`: `AudioTween` - The easing configuration for the panning change.

## seek_to

### Description
Sets the playback position to the specified time in seconds.

### Method
`seek_to(&mut self, position: f64)`

### Parameters
- `position`: `f64` - The desired playback position in seconds.

## seek_by

### Description
Moves the playback position by the specified amount of time in seconds.

### Method
`seek_by(&mut self, amount: f64)`

### Parameters
- `amount`: `f64` - The amount to move the playback position by in seconds.
```

--------------------------------

### into_sound

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundData.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts the loaded sound into a live, playing sound and a handle to control it.

```APIDOC
## fn into_sound( self, ) -> Result<(Box<dyn Sound>, <StaticSoundData as SoundData>::Handle), <StaticSoundData as SoundData>::Error>

### Description
Converts the loaded sound into a live, playing sound and a handle to control it.

### Method
(Implicitly part of the SoundData trait implementation for StaticSoundData)

### Parameters
- **self**: `StaticSoundData` - The instance of StaticSoundData to convert.

### Return Value
A `Result` containing a tuple of a boxed `dyn Sound` and the `StaticSoundData`'s `Handle` on success, or an error on failure.
```

--------------------------------

### Get Audio Instance Playback State

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioInstance.html?search=

Retrieves the current playback state of the audio instance. This can be used to check if audio is playing, paused, or stopped.

```rust
pub fn state(&self) -> PlaybackState
```

--------------------------------

### IntoSample<T>::into_sample

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.SpatialAudioReceiver.html?search=std%3A%3Avec

Converts into a sample.

```APIDOC
## fn into_sample(self) -> T

Converts into a sample.
```

--------------------------------

### to_sample_

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioSource.html?search=

Converts the AudioSource into a Sample type.

```APIDOC
## fn to_sample_(self) -> U

### Description
Converts the AudioSource into a Sample type.

### Method
N/A (Method on struct)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **U** - The Sample type.
```

--------------------------------

### StaticSoundSettings Struct Definition

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html?search=

Defines the structure for static sound settings, including fields for start time, loop region, volume, playback rate, and fade-in tween.

```rust
pub struct StaticSoundSettings {
    pub start_time: StartTime,
    pub start_position: PlaybackPosition,
    pub loop_region: Option<Region>,
    pub reverse: bool,
    pub volume: Value<Decibels>,
    pub playback_rate: Value<PlaybackRate>,
    pub panning: Value<Panning>,
    pub fade_in_tween: Option<Tween>,
}
```

--------------------------------

### Sample Conversions

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.Decibels.html

Methods for converting types to and from samples.

```APIDOC
## fn into_sample(self) -> T

Converts the type into a sample of type `T`. This is part of the `IntoSample` trait.

### Method
`into_sample`

### Parameters
- `self`: The value to convert.

### Returns
- `T` - The converted sample.
```

```APIDOC
## fn to_sample_(self) -> U

Converts `self` into a sample of type `U`. This is part of the `ToSample` trait.

### Method
`to_sample_`

### Parameters
- `self`: The value to convert.

### Returns
- `U` - The converted sample.
```

--------------------------------

### AudioSource Clone Implementation

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.AudioSource.html

Demonstrates the `clone` method for AudioSource, allowing for the creation of duplicate audio sources. This is useful for reusing audio data.

```rust
fn clone(&self) -> AudioSource
```

--------------------------------

### Get a Dynamic Audio Channel (Optional)

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/struct.DynamicAudioChannels.html

Safely retrieves an optional reference to the audio channel for the given key. Returns `Some(&DynamicAudioChannel)` if the channel exists, and `None` otherwise.

```rust
pub fn get_channel(&self, key: &str) -> Option<&DynamicAudioChannel>
```

--------------------------------

### Get &mut dyn Any from &mut Trait

Source: https://docs.rs/bevy_kira_audio/0.25.0/bevy_kira_audio/prelude/struct.StaticSoundSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Converts a `&mut Trait` to `&mut dyn Any`. This is needed because Rust cannot generate `&mut Any`'s vtable from `&mut Trait`'s.

```rust
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
```
Tokens:
Raw