Phaser API Documentation

  Version: 
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Event: GLOBAL_VOLUME
Phaser.Sound.Events.GLOBAL_VOLUME
GLOBAL_VOLUME

Description:

The Sound Manager Global Volume Event.

This event is dispatched by the Sound Manager when its volume property is changed, either directly or via the setVolume method. This changes the volume of all active sounds.

Listen to it from a Scene using: this.sound.on('volume', listener).

Parameters:

name type description
soundManager Phaser.Sound.WebAudioSoundManager | Phaser.Sound.HTML5AudioSoundManager

A reference to the sound manager that emitted the event.

volume number

The new global volume of the Sound Manager.

Since: 3.0.0