Phaser API Documentation

  Version: 

Member of: Phaser.Sound.BaseSound

pause()

Description:

Pauses the sound. This only works if the sound is currently playing.

You can inspect the isPlaying and isPaused properties to check the state.

Returns:
Description:

Whether the sound was paused successfully.

Type:
  • boolean
Since: 3.0.0
Source: src/sound/BaseSound.js (Line 343)