Struct SoundBank 

pub struct SoundBank { /* private fields */ }

A set of cues loaded once and kept alive for as long as the composable that remembered it stays in the composition.

Indexing is positional, so an app’s cue enum casts straight to an index; SoundBank::find covers the cases where a name is more convenient. The clips are released when the last clone drops.

Implementations

impl SoundBank

pub fn load(player: AudioPlayerRef, specs: &[SoundSpec<'_>]) -> SoundBank

Loads every spec through player, collecting the ones that fail rather than aborting the whole bank.

pub fn len(&self) -> usize

How many cues the bank holds, failures included.

pub fn is_empty(&self) -> bool

Whether the bank holds no cues.

pub fn entries(&self) -> &[SoundBankEntry]

The cues, in spec order.

pub fn failures(&self) -> &[SoundBankFailure]

The cues that failed to load.

pub fn player(&self) -> AudioPlayerRef

The player the bank loaded through.

pub fn id(&self, index: usize) -> SoundId

The handle at index, or SoundId::NONE when out of range.

pub fn find(&self, name: &str) -> Option<SoundId>

The handle for name, if the bank holds it.

pub fn play(&self, index: usize)

Plays a cue at its own level.

pub fn play_with(&self, index: usize, params: PlaybackParams)

Plays a cue, multiplying params.volume by the cue’s own level. The bus comes from the spec, so a cue cannot escape its bus by accident.

pub fn play_named(&self, name: &str, params: PlaybackParams)

Plays the cue called name, if the bank holds it.

pub fn play_loop(&self, index: usize, params: PlaybackParams) -> VoiceId

Starts a looping voice for a cue.

pub fn stop(&self, index: usize)

Stops every voice of a cue.

Trait Implementations

impl Clone for SoundBank

fn clone(&self) -> SoundBank

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SoundBank

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Index<usize> for SoundBank

type Output = SoundId

The returned type after indexing.

fn index(&self, index: usize) -> &SoundId

Performs the indexing (container[index]) operation.