Struct bevy_kira_audio::DynamicAudioChannels

pub struct DynamicAudioChannels { /* private fields */ }

Resource to play and control audio in dynamic channels

You should only use this if you need a number of audio channels that is not known at compile time. If that is not the case, typed channels are easier to use with Bevy’s ECS.

Implementations

impl DynamicAudioChannels

pub fn create_channel(&mut self, key: &str) -> &DynamicAudioChannel

Creates and returns an audio channel for the given key

If there already is a channel with the given key, it will be stopped and removed.

pub fn remove_channel(&mut self, key: &str)

Remove the channel behind the given key

All audio in the channel will be stopped before it is removed. This method will do nothing if there is no channel for the given key.

pub fn is_channel(&self, key: &str) -> bool

Checks if there is a channel available for the given key.

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

Get a channel to play and control audio in

Panics

This method will panic if there is no channel for the given key. If you aren’t sure that there is one, you can check with is_channel, or use get_channel instead.

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

Get a channel to play and control audio in

pub fn iter(&self) -> Iter<'_, String, DynamicAudioChannel>

An iterator over the keys and dynamic audio channels

Trait Implementations

impl Default for DynamicAudioChannels

fn default() -> DynamicAudioChannels

Returns the “default value” for a type.

impl Resource for DynamicAudioChannels

where Self: Send + Sync + 'static,