Interface SoundBank

interface SoundBank {
    audioEngine: AudioEngine;
    effectChainPrime: EffectChain;
    playerTargets: Map<string, AudioEngine.Target>;
    soundEffects: Map<string, EffectChain>;
    soundPlayers: Record<string, SoundPlayer>;
    addSoundPlayer(soundPlayer: SoundPlayer): void;
    dispose(): void;
    getSoundEffects(soundId: string): EffectChain;
    getSoundPlayer(soundId: string): undefined | SoundPlayer;
    playSound(target: AudioEngine.Target, soundId: string): Promise<void>;
    setEffects(target: AudioEngine.Target): void;
    stop(target: AudioEngine.Target, soundId: string): void;
    stopAllSounds(target: AudioEngine.Target | "*"): void;
}

Properties

audioEngine effectChainPrime playerTargets soundEffects soundPlayers

Methods

addSoundPlayer dispose getSoundEffects getSoundPlayer playSound setEffects stop stopAllSounds

Properties

audioEngine

audioEngine: AudioEngine

effectChainPrime

effectChainPrime: EffectChain

Original effect chain cloned for each sound.

playerTargets

playerTargets: Map<string, AudioEngine.Target>

Maps sound IDs to the target they were most recently been started by.

soundEffects

soundEffects: Map<string, EffectChain>

Maps sound IDs to their effect chain.

soundPlayers

soundPlayers: Record<string, SoundPlayer>

Maps sound ID to its sound player.

Methods

addSoundPlayer

dispose

getSoundEffects

getSoundPlayer

playSound

setEffects

stop

stopAllSounds

Settings

Member Visibility

On This Page

Properties
Methods