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.

Constructors

constructor

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

Methods

`Static` clampRate

clampRate(rate): number
Ensure rate is in a range valid for Howler.js
Parameters
- rate: number
Returns number
The clamped rate
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:470

clearAll

clearAll(): void
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:853

createHowlerSound

createHowlerSound(soundName, isMusic, volume, loop, rate): HowlerSound
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
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:580

dispose

dispose(): void
To be called when the game is disposed. Unloads all audio from memory, clear Howl cache and stop all audio.

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

getGlobalVolume

getGlobalVolume(): number
Returns number
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:849

getMusicOnChannel

getMusicOnChannel(channel): null | HowlerSound
Parameters
- channel: number
Returns null | HowlerSound
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:810

getResourceKinds

getResourceKinds(): ResourceKind[]
Returns ResourceKind[]
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:462

getSoundOnChannel

getSoundOnChannel(channel): null | HowlerSound
Parameters
- channel: number
Returns null | HowlerSound
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:761

loadAudio

loadAudio(soundName, isMusic): void
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
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:621

loadResource

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

pauseAllActiveSounds

pauseAllActiveSounds(): void
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:414

playMusic

playMusic(soundName, loop, volume, pitch): void
Parameters
- soundName: string
- loop: boolean
- volume: number
- pitch: number
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:765

playMusicOnChannel

playMusicOnChannel(soundName, channel, loop, volume, pitch): void
Parameters
- soundName: string
- channel: number
- loop: boolean
- volume: number
- pitch: number
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:783

playSound

playSound(soundName, loop, volume, pitch): void
Parameters
- soundName: string
- loop: boolean
- volume: number
- pitch: number
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:711

playSoundOnChannel

playSoundOnChannel(soundName, channel, loop, volume, pitch): void
Parameters
- soundName: string
- channel: number
- loop: boolean
- volume: number
- pitch: number
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:729

processResource

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

resumeAllActiveSounds

resumeAllActiveSounds(): void
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:436

setGlobalVolume

setGlobalVolume(volume): void
Parameters
- volume: number
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:838

setSoundSpatialPositionOnChannel

setSoundSpatialPositionOnChannel(channel, x, y, z): void
Parameters
- channel: number
- x: number
- y: number
- z: number
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:814

unloadAll

unloadAll(): void
Unloads all audio from memory. This will clear the Howl cache. This will also stop any running music or sounds.

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

unloadAudio

unloadAudio(soundName, isMusic): void
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
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:658

unloadResourcesList

unloadResourcesList(resourcesList): void
Unload the specified list of resources: this unloads all audio from the specified resources from memory.

Usually called when scene resoures are unloaded.
Parameters
- resourcesList: ResourceData[]
  The list of specific resources
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:951

Class HowlerSoundManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns HowlerSoundManager

Methods

Static clampRate

Parameters

Returns number

clearAll

Returns void

createHowlerSound

Parameters

Returns HowlerSound

dispose

Returns void

getGlobalVolume

Returns number

getMusicOnChannel

Parameters

Returns null | HowlerSound

getResourceKinds

Returns ResourceKind[]

getSoundOnChannel

Parameters

Returns null | HowlerSound

loadAudio

Parameters

Returns void

loadResource

Parameters

Returns Promise<void>

pauseAllActiveSounds

Returns void

playMusic

Parameters

Returns void

playMusicOnChannel

Parameters

Returns void

playSound

Parameters

Returns void

playSoundOnChannel

Parameters

Returns void

processResource

Parameters

Returns Promise<void>

resumeAllActiveSounds

Returns void

setGlobalVolume

Parameters

Returns void

setSoundSpatialPositionOnChannel

Parameters

Returns void

unloadAll

Returns void

unloadAudio

Parameters

Returns void

unloadResourcesList

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Static` clampRate