Phaser API Documentation



The Sound Manager Global Mute Event.

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

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


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

A reference to the Sound Manager that emitted the event.

mute boolean

The mute value. true if the Sound Manager is now muted, otherwise false.

Since: 3.0.0