SoundManager.remove(sound) now lets you remove a sound from the SoundManager, destroying it in the process.

Sound.destroy will remove a sound and all local references it holds, optionally removing itself from the SoundManager as well.

Author: photonstorm

README.md

@@ -86,6 +86,8 @@ New Features
 * Graphics chaining functions.
 * Added Pointer.positionUp which records the last point at which the pointer left the screen (thanks @Cryszon, #676)
 * Phaser.Point.centroid static function added to calculate the centroid or midpoint of an array of points (thanks @lewster32, #675)
+* SoundManager.remove(sound) now lets you remove a sound from the SoundManager, destroying it in the process.
+* Sound.destroy will remove a sound and all local references it holds, optionally removing itself from the SoundManager as well.
 
 
 Bug Fixes

src/sound/Sound.js

@@ -662,6 +662,7 @@ Phaser.Sound.prototype = {
 
     /**
     * Stop playing this sound.
+    *
     * @method Phaser.Sound#stop
     */
     stop: function () {
@@ -697,6 +698,38 @@ Phaser.Sound.prototype = {
         this.currentMarker = '';
         this.onStop.dispatch(this, prevMarker);
 
+    },
+
+    /**
+    * Destroys this sound and all associated events and removes it from the SoundManager.
+    *
+    * @method Phaser.Sound#destroy
+    * @param {boolean} [remove=true] - If true this Sound is automatically removed from the SoundManager.
+    */
+    destroy: function (remove) {
+
+        if (typeof remove === 'undefined') { remove = true; }
+
+        this.stop();
+
+        if (remove)
+        {
+            this.game.sound.remove(this);
+        }
+
+        this.markers = {};
+        this.context = null;
+        this._buffer = null;
+        this.externalNode = null;
+        this.onDecoded.dispose();
+        this.onPlay.dispose();
+        this.onPause.dispose();
+        this.onResume.dispose();
+        this.onLoop.dispose();
+        this.onStop.dispose();
+        this.onMute.dispose();
+        this.onMarkerComplete.dispose();
+
     }
 
 };

src/sound/SoundManager.js

@@ -57,7 +57,6 @@ Phaser.SoundManager = function (game) {
     /**
     * @property {array} _sounds - An array containing all the sounds
     * @private
-    * @default The empty array.
     */
     this._sounds = [];
 
@@ -364,8 +363,34 @@ Phaser.SoundManager.prototype = {
 
     },
 
+    /**
+    * Removes a Sound from the SoundManager. The removed Sound is destroyed before removal.
+    *
+    * @method Phaser.SoundManager#remove
+    * @param {Phaser.Sound} sound - The sound object to remove.
+    * @return {boolean} True if the sound was removed successfully, otherwise false.
+    */
+    remove: function (sound) {
+
+        var i = this._sounds.length;
+
+        while (i--)
+        {
+            if (this._sounds[i] === sound)
+            {
+                this._sounds[i].destroy(false);
+                this._sounds.splice(i, 1);
+                return true;
+            }
+        }
+
+        return false;
+
+    },
+
     /**
     * Adds a new Sound into the SoundManager and starts it playing.
+    *
     * @method Phaser.SoundManager#play
     * @param {string} key - Asset key for the sound.
     * @param {number} [volume=1] - Default value for the volume.