core/com.pico.spatial.core.ecs/AudioResourceLibraryComponent

AudioResourceLibraryComponent

@MainThread

class AudioResourceLibraryComponent : Component

A Component that manages audio resources as a key-value dictionary for organized audio playback.

This component provides centralized storage and access to AudioResource instances using named keys. AudioResources can be added, removed, and retrieved using named keys, enabling:

Structured audio resource management.
Dynamic runtime audio switching.
Timeline integration for sequenced playback.

Constructors

AudioResourceLibraryComponent

constructor()

Constructs an empty AudioResourceLibraryComponent.

Functions

add

fun add(name: String, resource: AudioAsset): Boolean

Adds an AudioAsset to the AudioResourceLibraryComponent using a specified name.

clear

fun clear()

Removes all AudioResources and AudioGroupResources from the AudioResourceLibraryComponent.

clone

open override fun clone(): Component

Creates and returns a copy of this Component instance.

contains

fun contains(name: String): Boolean

Checks if the AudioResourceLibraryComponent contains an AudioResource with the given name.

equals

open operator override fun equals(other: Any?): Boolean

get

fun get(name: String): AudioResource?

Gets an AudioResource from the AudioResourceLibraryComponent using a specified name.

inline fun <T : AudioAsset> get(name: String): T?

Gets an AudioAsset of a specific type from the AudioResourceLibraryComponent using a specified name.

getAllAudioGroupResources

fun getAllAudioGroupResources(): List<AudioGroupResource>

Gets all AudioGroupResources within the AudioResourceLibraryComponent.

getAllAudioResources

fun getAllAudioResources(): List<AudioResource>

Gets all AudioResources within the AudioResourceLibraryComponent.

getAllNames

fun getAllNames(): List<String>

Gets the names of all AudioResources and AudioGroupResources within the AudioResourceLibraryComponent.

hashCode

open override fun hashCode(): Int

remove

fun remove(name: String)

Removes an AudioAsset from the AudioResourceLibraryComponent using a specified name.

toString

open override fun toString(): String