Class HowlerSoundManager

HowlerSoundManager is used to manage the sounds and musics of a RuntimeScene.

It is basically a container to associate channels to sounds and keep a list of all sounds being played.

Hierarchy

HowlerSoundManager

Index

Methods

Constructors

constructor

Methods

Static clampRate

clampRate(rate: number): number

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:444
Ensure rate is in a range valid for Howler.js

Parameters
- rate: number
Returns number
The clamped rate

clearAll

clearAll(): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:749
Returns void

createHowlerSound

createHowlerSound(soundName: string, isMusic: boolean, volume: number, loop: boolean, rate: number): HowlerSound

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:508
Creates a new gdjs.HowlerSound using preloaded/cached Howl instances.

Parameters
- soundName: string
  
  The name of the file or resource to play.
- isMusic: boolean
  
  True if a music, false if a sound.
- volume: number
  
  Between 0 and 1.
- loop: boolean
  
  True if it should be played looping.
- rate: number
  
  speed at which it is played.
Returns HowlerSound

getGlobalVolume

getGlobalVolume(): number

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:745
Returns number

getMusicOnChannel

getMusicOnChannel(channel: number): null | HowlerSound

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:730
Parameters
- channel: number
Returns null | HowlerSound

getResourceKinds

getResourceKinds(): ResourceKind[]

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:436
Returns ResourceKind[]

getSoundOnChannel

getSoundOnChannel(channel: number): null | HowlerSound

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:682
Parameters
- channel: number
Returns null | HowlerSound

loadAudio

loadAudio(soundName: string, isMusic: boolean): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:549
Preloads a sound or a music in memory.

Parameters
- soundName: string
  
  The name of the file or resource to preload.
- isMusic: boolean
  
  True if a music, false if a sound.
Returns void

loadResource

loadResource(resourceName: string): Promise<void>

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:763
Parameters
- resourceName: string
Returns Promise<void>

playMusic

playMusic(soundName: string, loop: boolean, volume: number, pitch: number): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:686
Parameters
- soundName: string
- loop: boolean
- volume: number
- pitch: number
Returns void

playMusicOnChannel

playMusicOnChannel(soundName: string, channel: number, loop: boolean, volume: number, pitch: number): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:704
Parameters
- soundName: string
- channel: number
- loop: boolean
- volume: number
- pitch: number
Returns void

playSound

playSound(soundName: string, loop: boolean, volume: number, pitch: number): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:638
Parameters
- soundName: string
- loop: boolean
- volume: number
- pitch: number
Returns void

playSoundOnChannel

playSoundOnChannel(soundName: string, channel: number, loop: boolean, volume: number, pitch: number): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:656
Parameters
- soundName: string
- channel: number
- loop: boolean
- volume: number
- pitch: number
Returns void

processResource

processResource(resourceName: string): Promise<void>

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:759
Parameters
- resourceName: string
Returns Promise<void>

setGlobalVolume

setGlobalVolume(volume: number): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:734
Parameters
- volume: number
Returns void

unloadAll

unloadAll(): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:625
Unloads all audio from memory. This will clear the Howl cache. This will also stop any running music or sounds.

Returns void

unloadAudio

unloadAudio(soundName: string, isMusic: boolean): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:585
Unloads a sound or a music from memory. This will stop any sound/music using it.

Parameters
- soundName: string
  
  The name of the file or resource to unload.
- isMusic: boolean
  
  True if a music, false if a sound.
Returns void

Constructors

constructor

new HowlerSoundManager(resourceLoader: ResourceLoader): HowlerSoundManager

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:388
Parameters
- resourceLoader: ResourceLoader
  
  The resources loader of the game.
Returns HowlerSoundManager

Generated using TypeDoc