HowlerSoundManager | GDevelop JavaScript game engine

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:452
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:750
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:514
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:746
Returns number

getMusicOnChannel

getMusicOnChannel(channel: number): null | HowlerSound

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

getSoundOnChannel

getSoundOnChannel(channel: number): null | HowlerSound

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

loadAudio

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

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:557
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

playMusic

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

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:687
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:705
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:639
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:657
Parameters
- soundName: string
- channel: number
- loop: boolean
- volume: number
- pitch: number
Returns void

preloadAudio

preloadAudio(onProgress: (loadedCount: number, totalCount: number) => void, onComplete: (totalCount: number) => void, resources?: ResourceData[]): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:760
Parameters
- onProgress: (loadedCount: number, totalCount: number) => void
  - - (loadedCount: number, totalCount: number): void
    - Parameters
      - loadedCount: number
      - totalCount: number
      Returns void
- onComplete: (totalCount: number) => void
  - - (totalCount: number): void
    - Parameters
      - totalCount: number
      Returns void
- Optional resources: ResourceData[]
Returns void

setGlobalVolume

setGlobalVolume(volume: number): void

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

setResources

setResources(resources: ResourceData[]): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:444
Update the resources data of the game. Useful for hot-reloading, should not be used otherwise.

Parameters
- resources: ResourceData[]
  
  The resources data of the game.
Returns void

unloadAll

unloadAll(): void

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:626
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:588
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(resources: ResourceData[], resourcesLoader: RuntimeGameResourcesLoader): HowlerSoundManager

- Defined in GDJS/Runtime/howler-sound-manager/howler-sound-manager.ts:387
Parameters
- resources: ResourceData[]
  
  The resources data of the game.
- resourcesLoader: RuntimeGameResourcesLoader
  
  The resources loader of the game.
Returns HowlerSoundManager

Hierarchy

Index

Methods

Constructors

Methods

Static clampRate

Parameters

rate: number

Returns number

clearAll

Returns void

createHowlerSound

Parameters

soundName: string

isMusic: boolean

volume: number

loop: boolean

rate: number

Returns HowlerSound

getGlobalVolume

Returns number

getMusicOnChannel

Parameters

channel: number

Returns null | HowlerSound

getSoundOnChannel

Parameters

channel: number

Returns null | HowlerSound

loadAudio

Parameters

soundName: string

isMusic: boolean

Returns void

playMusic

Parameters

soundName: string

loop: boolean

volume: number

pitch: number

Returns void

playMusicOnChannel

Parameters

soundName: string

channel: number

loop: boolean

volume: number

pitch: number

Returns void

playSound

Parameters

soundName: string

loop: boolean

volume: number

pitch: number

Returns void

playSoundOnChannel

Parameters

soundName: string

channel: number

loop: boolean

volume: number

pitch: number

Returns void

preloadAudio

Parameters

onProgress: (loadedCount: number, totalCount: number) => void

Parameters

loadedCount: number

totalCount: number

Returns void

onComplete: (totalCount: number) => void

Parameters

totalCount: number

Returns void

Optional resources: ResourceData[]

Returns void

setGlobalVolume

Parameters

volume: number