AudioSprite support is now built into the Loader and SoundManager. AudioSprites are like sprite sheets, only they consist of a selection of audio files and markers in a json configuration. You can find more details at https://github.com/tonistiigi/audiosprite (thanks @codevinsky phaserjs#1205)

Fixed AudioSprite jsdoc, casing and formatting issues.

Author: photonstorm

README.md

@@ -81,6 +81,7 @@ Version 2.1.2 - "Whitebridge" - in development
 * Loader can now natively load XML files via `load.xml`. Once the XML file has loaded it is parsed via either DOMParser or ActiveXObject and then added to the Cache, where it can be retrieved via `cache.getXML(key)`.
 * Cache now has support for XML files stored in their own container. You can add them with `cache.addXML` (typically this is done from the Loader automatically for you) and get them with `cache.getXML(key)`. There is also `cache.checkXMLKey(key)`, `cache.checkKeys` and `cache.removeXML(key)`.
 * Rectangle.aabb is a new method that will take an array of Points and return a Rectangle that matches the AABB (bounding area) of the Points (thanks @codevinsky #1199)
+* AudioSprite support is now built into the Loader and SoundManager. AudioSprites are like sprite sheets, only they consist of a selection of audio files and markers in a json configuration. You can find more details at https://github.com/tonistiigi/audiosprite (thanks @codevinsky #1205)
 
 
 ### Updates

src/gameobjects/GameObjectCreator.js

@@ -124,15 +124,18 @@ Phaser.GameObjectCreator.prototype = {
         return this.game.sound.add(key, volume, loop, connect);
 
     },
+
     /**
      * Creates a new AudioSprite object.
      *
-     * @method Phaser.GameObjectCreator#audioSrpite
+     * @method Phaser.GameObjectCreator#audioSprite
      * @param {string} key - The Game.cache key of the sound that this object will use.
-     * @return {Phaser.AudioSprite} The newly created audioSprite object.
+     * @return {Phaser.AudioSprite} The newly created AudioSprite object.
      */
-    audiosprite: function(key) {
+    audioSprite: function (key) {
+
         return this.game.sound.addSprite(key);
+
     },
 
     /**

src/gameobjects/GameObjectFactory.js

@@ -182,12 +182,14 @@ Phaser.GameObjectFactory.prototype = {
     /**
      * Creates a new AudioSprite object.
      *
-     * @method Phaser.GameObjectCreator#audioSrpite
+     * @method Phaser.GameObjectFactory#audioSprite
      * @param {string} key - The Game.cache key of the sound that this object will use.
-     * @return {Phaser.AudioSprite} The newly created audioSprite object.
+     * @return {Phaser.AudioSprite} The newly created AudioSprite object.
      */
-    audiosprite: function(key) {
+    audioSprite: function (key) {
+
         return this.game.sound.addSprite(key);
+
     },
 
     /**

src/loader/Loader.js

@@ -615,18 +615,23 @@ Phaser.Loader.prototype = {
     },
 
     /**
-     * Add a new audiosprite file to the loader.
+     * Add a new audiosprite file to the loader. Audio Sprites are a combination of audio files and a JSON configuration.
+     * The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite
      *
      * @method Phaser.Loader#audiosprite
      * @param {string} key - Unique asset key of the audio file.
      * @param {Array|string} urls - An array containing the URLs of the audio files, i.e.: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] or a single string containing just one URL.
-     * @param {string} atlasurl - the url containing the audiosprite configuration json
+     * @param {string} atlasURL - The URL of the audiosprite configuration json.
      * @return {Phaser.Loader} This Loader instance.
      */
-    audiosprite: function(key, urls, atlasurl) {
+    audiosprite: function(key, urls, atlasURL) {
+
         this.audio(key, urls);
-        this.json(key + '-audioatlas', atlasurl);
+
+        this.json(key + '-audioatlas', atlasURL);
+
         return this;
+
     },
 
     /**

src/sound/AudioSprite.js

@@ -1,76 +1,137 @@
 /**
  * @author       Jeremy Dowell <jeremy@codevinsky.com>
+ * @author       Richard Davey <rich@photonstorm.com>
  * @copyright    2014 Photon Storm Ltd.
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
 /**
- * The AudioSprite class constructor.
+ * Audio Sprites are a combination of audio files and a JSON configuration.
+ * The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite
  *
  * @class Phaser.AudioSprite
  * @constructor
  * @param {Phaser.Game} game - Reference to the current game instance.
  * @param {string} key - Asset key for the sound.
  */
+Phaser.AudioSprite = function (game, key) {
 
-Phaser.AudioSprite = function(game, key) {
+    /**
+    * A reference to the currently running Game.
+    * @property {Phaser.Game} game
+    */
     this.game = game;
+
+    /**
+     * Asset key for the Audio Sprite.
+     * @property {string} key
+     */
     this.key = key;
+
+    /**
+     * JSON audio atlas object.
+     * @property {object} config
+     */
     this.config = this.game.cache.getJSON(key + '-audioatlas');
+
+    /**
+     * If a sound is set to auto play, this holds the marker key of it.
+     * @property {string} autoplayKey
+     */
     this.autoplayKey = null;
-    this.autoplay = null;
+
+    /**
+     * Is a sound set to autoplay or not?
+     * @property {boolean} autoplay
+     * @default
+     */
+    this.autoplay = false;
+
+    /**
+     * An object containing the Phaser.Sound objects for the Audio Sprite.
+     * @property {object} sounds
+     */
     this.sounds = {};
-    for (var k in this.config.spritemap) {
+
+    for (var k in this.config.spritemap)
+    {
         var marker = this.config.spritemap[k];
-        var s = this.game.add.sound(this.key);
-        if (marker.loop) {
-            s.addMarker(k, marker.start, (marker.end - marker.start), null, true);
-        } else {
-            s.addMarker(k, marker.start, (marker.end - marker.start), null, false);
+        var sound = this.game.add.sound(this.key);
+
+        if (marker.loop)
+        {
+            sound.addMarker(k, marker.start, (marker.end - marker.start), null, true);
+        }
+        else
+        {
+            sound.addMarker(k, marker.start, (marker.end - marker.start), null, false);
         }
+
         this.sounds[k] = s;
     }
-    if (this.config.autoplay) {
+
+    if (this.config.autoplay)
+    {
         this.autoplayKey = this.config.autoplay;
         this.play(this.autoplayKey);
         this.autoplay = this.sounds[this.autoplayKey];
     }
+
 };
 
 Phaser.AudioSprite.prototype = {
+
     /**
-     * Play a sound with the given name
+     * Play a sound with the given name.
+     * 
      * @method Phaser.AudioSprite#play
      * @param {string} [marker] - The name of sound to play
      * @param {number} [volume=1] - Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).
      * @return {Phaser.Sound} This sound instance.
      */
-    play: function(marker, volume) {
-        volume = typeof volume === 'undefined' ? 1 : volume;
+    play: function (marker, volume) {
+
+        if (typeof volume === 'undefined') { volume = 1; }
+
         return this.sounds[marker].play(marker, null, volume);
+
     },
+
     /**
-     * Play a sound with the given name
+     * Stop a sound with the given name.
+     * 
      * @method Phaser.AudioSprite#stop
-     * @param {string} [marker=''] - The name of sound to stop. If none is given, stop all sounds in the audiosprite
-     * @return {Phaser.Sound} This sound instance.
+     * @param {string} [marker=''] - The name of sound to stop. If none is given it will stop all sounds in the audio sprite.
      */
-    stop: function(marker) {
-        if (!marker) {
-            for (var key in this.sounds) {
+    stop: function (marker) {
+
+        if (!marker)
+        {
+            for (var key in this.sounds)
+            {
                 this.sounds[key].stop();
             }
-        } else {
+        }
+        else
+        {
             this.sounds[marker].stop();
         }
+
     },
+
     /**
-     * Get a sound with the given name
-     * @method Phaser.AudioSprite#play
-     * @param {string} [marker] - The name of sound to get
-     * @return {Phaser.Sound} This sound instance.
+     * Get a sound with the given name.
+     * 
+     * @method Phaser.AudioSprite#get
+     * @param {string} marker - The name of sound to get.
+     * @return {Phaser.Sound} The sound instance.
      */
     get: function(marker) {
+
         return this.sounds[marker];
+
     }
+
 };
+
+Phaser.AudioSprite.prototype.constructor = Phaser.AudioSprite;

src/sound/SoundManager.js

@@ -369,13 +369,16 @@ Phaser.SoundManager.prototype = {
     /**
      * Adds a new AudioSprite into the SoundManager.
      *
-     * @method Phaser.SoundManager#add
+     * @method Phaser.SoundManager#addSprite
      * @param {string} key - Asset key for the sound.
      * @return {Phaser.AudioSprite} The new AudioSprite instance.
      */
     addSprite: function(key) {
+
         var audioSprite = new Phaser.AudioSprite(this.game, key);
+
         return audioSprite;
+
     },
 
     /**