Class HowlerSoundManager

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

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

Implements

ResourceManager

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:509

Properties

`Static` `Private` playedSoundsLogMaxSize

playedSoundsLogMaxSize: number = 500

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:597

clearAll

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

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:732

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
Implementation of ResourceManager.dispose
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1245

getGlobalVolume

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

getMusicOnChannel

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

getNetworkSyncData

getNetworkSyncData(): SoundManagerSyncData
Returns SoundManagerSyncData
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1150

getPlayedSoundsLog

getPlayedSoundsLog(): {
isMusic: boolean;
soundName: string;
}[]
The sounds and musics played since the log was enabled (capped), oldest first. Empty when the log is not enabled.

Returns {
isMusic: boolean;
soundName: string;
}[]
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:720

getResourceKinds

getResourceKinds(): ResourceKind[]
Return the kind of resources handled by this manager.

Returns ResourceKind[]
Implementation of ResourceManager.getResourceKinds
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:589

getSoundOnChannel

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

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:778

loadResource

loadResource(resourceName): Promise<void>
Load the specified resource.

This method will be run during the game. It should only do light tasks like file downloading.
Parameters
- resourceName: string
Returns Promise<void>
Implementation of ResourceManager.loadResource
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1068

muteEverything

muteEverything(reason): void
Parameters
- reason: string
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1021

pauseAllActiveSounds

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

playMusic

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

playMusicOnChannel

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

playSound

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

playSoundOnChannel

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

processResource

processResource(resourceName): Promise<void>
Process the specified resource.

This method will only be run while loading screen is shown. It can do heavy tasks like parsing data.
Parameters
- resourceName: string
Returns Promise<void>
Implementation of ResourceManager.processResource
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1064

resumeAllActiveSounds

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

setGlobalVolume

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

setPlayedSoundsLogEnabled

setPlayedSoundsLogEnabled(enable): void
Enable (clearing any previous entries) or disable the recording of the played sounds and musics, read with getPlayedSoundsLog. Used by gameplay tests to check that a sound was played.
Parameters
- enable: boolean
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:712

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:997

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:855

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:815

unloadResource

unloadResource(resourceData): void
Clear any data in cache for a resource. Embedded resources are also cleared.

Usually called when scene resources are unloaded.
Parameters
- resourceData: ResourceData
  The resource to clear
Returns void
Implementation of ResourceManager.unloadResource
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1249

unmuteEverything

unmuteEverything(reason): void
Parameters
- reason: string
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1026

updateFromNetworkSyncData

updateFromNetworkSyncData(syncData): void
Parameters
- syncData: SoundManagerSyncData
Returns void
- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:1188

Class HowlerSoundManager

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HowlerSoundManager

Properties

Static Private playedSoundsLogMaxSize

Methods

Static clampRate

Parameters

Returns number

clearAll

Returns void

createHowlerSound

Parameters

Returns HowlerSound

dispose

Returns void

getGlobalVolume

Returns number

getMusicOnChannel

Parameters

Returns null | HowlerSound

getNetworkSyncData

Returns SoundManagerSyncData

getPlayedSoundsLog

Returns { isMusic: boolean; soundName: string; }[]

getResourceKinds

Returns ResourceKind[]

getSoundOnChannel

Parameters

Returns null | HowlerSound

loadAudio

Parameters

Returns void

loadResource

Parameters

Returns Promise<void>

muteEverything

Parameters

Returns 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

setPlayedSoundsLogEnabled

Parameters

Returns void

setSoundSpatialPositionOnChannel

Parameters

Returns void

unloadAll

Returns void

unloadAudio

Parameters

Returns void

unloadResource

`Static` `Private` playedSoundsLogMaxSize

`Static` clampRate

Returns {
isMusic: boolean;
soundName: string;
}[]