deprecate HTMLAudioPlugin defaultNumChannels and cleaned up associated code

Author: OJay Robinson

VERSIONS.txt

@@ -13,6 +13,7 @@ CRITICAL (may break existing content):
 - added muted and volume properties to Sound, and deprecated get/setMute and get/setVolume
 - added capabilities property to Sound, and deprecated getCapabilities and getCapability
 - refactor HTMLAudioTagPool as Chrome no longer requires tags be pre-created
+- deprecate HTMLAudioPlugin defaultNumChannels and cleaned up associated code
 
 Version 0.6.0 [December 12, 2014]
 ************************************************************************************************************************

docs/soundjs_docs-NEXT.zip

@@ -1601,6 +1601,6 @@ this.createjs = this.createjs || {};
 	 * @type String
 	 * @static
 	 **/
-	s.buildDate = /*=date*/"Tue, 24 Feb 2015 23:16:21 GMT"; // injected by build process
+	s.buildDate = /*=date*/"Wed, 25 Feb 2015 18:08:25 GMT"; // injected by build process
 
 })();

lib/flashaudioplugin-NEXT.combined.js

@@ -30,7 +30,7 @@ this.createjs = this.createjs || {};
 	 * @type String
 	 * @static
 	 **/
-	s.buildDate = /*=date*/"Tue, 24 Feb 2015 23:16:21 GMT"; // injected by build process
+	s.buildDate = /*=date*/"Wed, 25 Feb 2015 18:08:25 GMT"; // injected by build process
 
 })();
 
@@ -3850,7 +3850,7 @@ this.createjs = this.createjs || {};
 		loadItem.type = "sound";
 
 		var data = loadItem.data;
-		var numChannels = s.activePlugin.defaultNumChannels || null;
+		var numChannels = null;
 		if (data != null) {
 			if (!isNaN(data.channels)) {
 				numChannels = parseInt(data.channels);
@@ -3867,7 +3867,7 @@ this.createjs = this.createjs || {};
 			}
 		}
 		if (loadItem.id != null) {s._idHash[loadItem.id] = {src: loadItem.src}};
-		var loader = s.activePlugin.register(loadItem, numChannels);  // Note only HTML audio uses numChannels
+		var loader = s.activePlugin.register(loadItem);
 
 		SoundChannel.create(loadItem.src, numChannels);
 
@@ -5780,11 +5780,10 @@ this.createjs = this.createjs || {};
 	 * can use to assist with preloading.
 	 * @method register
 	 * @param {String} loadItem An Object containing the source of the audio
-	 * @param {Number} instances The number of concurrently playing instances to allow for the channel at any time.
 	 * Note that not every plugin will manage this value.
 	 * @return {Object} A result object, containing a "tag" for preloading purposes.
 	 */
-	p.register = function (loadItem, instances) {
+	p.register = function (loadItem) {
 		var loader = this._loaders[loadItem.src];
 		if(loader && !loader.canceled) {return this._loaders[loadItem.src];}	// already loading/loaded this, so don't load twice
 		// OJR potential issue that we won't be firing loaded event, might need to trigger if this is already loaded?
@@ -6693,6 +6692,7 @@ this.createjs = this.createjs || {};
 	 * A hash lookup of if a base audio tag is available, indexed by the audio source
 	 * @property _tagsUsed
 	 * @type {{}}
+	 * @protected
 	 * @static
 	 */
 	s._tagUsed = {};
@@ -7105,9 +7105,8 @@ this.createjs = this.createjs || {};
 	 * <h4>Known Browser and OS issues for HTML Audio</h4>
 	 * <b>All browsers</b><br />
 	 * Testing has shown in all browsers there is a limit to how many audio tag instances you are allowed.  If you exceed
-	 * this limit, you can expect to see unpredictable results.  This will be seen as soon as you register sounds, as
-	 * tags are precreated to allow Chrome to load them.  Please use {{#crossLink "Sound.MAX_INSTANCES"}}{{/crossLink}} as
-	 * a guide to how many total audio tags you can safely use in all browsers.
+	 * this limit, you can expect to see unpredictable results. Please use {{#crossLink "Sound.MAX_INSTANCES"}}{{/crossLink}} as
+	 * a guide to how many total audio tags you can safely use in all browsers.  This issue is primarily limited to IE9.
 	 *
      * <b>IE html limitations</b><br />
      * <ul><li>There is a delay in applying volume changes to tags that occurs once playback is started. So if you have
@@ -7116,7 +7115,7 @@ this.createjs = this.createjs || {};
      * <li>MP3 encoding will not always work for audio tags if it's not default.  We've found default encoding with
      * 64kbps works.</li>
 	 * <li>Occasionally very short samples will get cut off.</li>
-	 * <li>There is a limit to how many audio tags you can load and play at once, which appears to be determined by
+	 * <li>There is a limit to how many audio tags you can load or play at once, which appears to be determined by
 	 * hardware and browser settings.  See {{#crossLink "HTMLAudioPlugin.MAX_INSTANCES"}}{{/crossLink}} for a safe estimate.
 	 * Note that audio sprites can be used as a solution to this issue.</li></ul>
 	 *
@@ -7154,15 +7153,14 @@ this.createjs = this.createjs || {};
 
 	// Public Properties
 		/**
-		 * The default number of instances to allow.  Used by {{#crossLink "Sound"}}{{/crossLink}} when a source
-		 * is registered using the {{#crossLink "Sound/register"}}{{/crossLink}} method.  This is only used if
-		 * a value is not provided.
+		 * This is no longer needed as we are now using object pooling for tags.
 		 *
 		 * <b>NOTE this property only exists as a limitation of HTML audio.</b>
 		 * @property defaultNumChannels
 		 * @type {Number}
 		 * @default 2
 		 * @since 0.4.0
+		 * @deprecated
 		 */
 		this.defaultNumChannels = 2;
 
@@ -7181,7 +7179,7 @@ this.createjs = this.createjs || {};
 
 // Static Properties
 	/**
-	 * The maximum number of instances that can be loaded and played. This is a browser limitation, primarily limited to IE9.
+	 * The maximum number of instances that can be loaded or played. This is a browser limitation, primarily limited to IE9.
 	 * The actual number varies from browser to browser (and is largely hardware dependant), but this is a safe estimate.
 	 * Audio sprites work around this limitation.
 	 * @property MAX_INSTANCES
@@ -7298,9 +7296,9 @@ this.createjs = this.createjs || {};
 
 
 // public methods
-	p.register = function (loadItem, instances) {
+	p.register = function (loadItem) {
 		var tag = createjs.HTMLAudioTagPool.get(loadItem.src);
-		var loader = this.AbstractPlugin_register(loadItem, instances);
+		var loader = this.AbstractPlugin_register(loadItem);
 		loader.setTag(tag);
 
 		return loader;

lib/flashaudioplugin-NEXT.min.js

@@ -141,11 +141,10 @@ this.createjs = this.createjs || {};
 	 * can use to assist with preloading.
 	 * @method register
 	 * @param {String} loadItem An Object containing the source of the audio
-	 * @param {Number} instances The number of concurrently playing instances to allow for the channel at any time.
 	 * Note that not every plugin will manage this value.
 	 * @return {Object} A result object, containing a "tag" for preloading purposes.
 	 */
-	p.register = function (loadItem, instances) {
+	p.register = function (loadItem) {
 		var loader = this._loaders[loadItem.src];
 		if(loader && !loader.canceled) {return this._loaders[loadItem.src];}	// already loading/loaded this, so don't load twice
 		// OJR potential issue that we won't be firing loaded event, might need to trigger if this is already loaded?

lib/soundjs-NEXT.combined.js

@@ -813,7 +813,7 @@ this.createjs = this.createjs || {};
 		loadItem.type = "sound";
 
 		var data = loadItem.data;
-		var numChannels = s.activePlugin.defaultNumChannels || null;
+		var numChannels = null;
 		if (data != null) {
 			if (!isNaN(data.channels)) {
 				numChannels = parseInt(data.channels);
@@ -830,7 +830,7 @@ this.createjs = this.createjs || {};
 			}
 		}
 		if (loadItem.id != null) {s._idHash[loadItem.id] = {src: loadItem.src}};
-		var loader = s.activePlugin.register(loadItem, numChannels);  // Note only HTML audio uses numChannels
+		var loader = s.activePlugin.register(loadItem);
 
 		SoundChannel.create(loadItem.src, numChannels);
 

lib/soundjs-NEXT.min.js

@@ -46,9 +46,8 @@ this.createjs = this.createjs || {};
 	 * <h4>Known Browser and OS issues for HTML Audio</h4>
 	 * <b>All browsers</b><br />
 	 * Testing has shown in all browsers there is a limit to how many audio tag instances you are allowed.  If you exceed
-	 * this limit, you can expect to see unpredictable results.  This will be seen as soon as you register sounds, as
-	 * tags are precreated to allow Chrome to load them.  Please use {{#crossLink "Sound.MAX_INSTANCES"}}{{/crossLink}} as
-	 * a guide to how many total audio tags you can safely use in all browsers.
+	 * this limit, you can expect to see unpredictable results. Please use {{#crossLink "Sound.MAX_INSTANCES"}}{{/crossLink}} as
+	 * a guide to how many total audio tags you can safely use in all browsers.  This issue is primarily limited to IE9.
 	 *
      * <b>IE html limitations</b><br />
      * <ul><li>There is a delay in applying volume changes to tags that occurs once playback is started. So if you have
@@ -57,7 +56,7 @@ this.createjs = this.createjs || {};
      * <li>MP3 encoding will not always work for audio tags if it's not default.  We've found default encoding with
      * 64kbps works.</li>
 	 * <li>Occasionally very short samples will get cut off.</li>
-	 * <li>There is a limit to how many audio tags you can load and play at once, which appears to be determined by
+	 * <li>There is a limit to how many audio tags you can load or play at once, which appears to be determined by
 	 * hardware and browser settings.  See {{#crossLink "HTMLAudioPlugin.MAX_INSTANCES"}}{{/crossLink}} for a safe estimate.
 	 * Note that audio sprites can be used as a solution to this issue.</li></ul>
 	 *
@@ -95,15 +94,14 @@ this.createjs = this.createjs || {};
 
 	// Public Properties
 		/**
-		 * The default number of instances to allow.  Used by {{#crossLink "Sound"}}{{/crossLink}} when a source
-		 * is registered using the {{#crossLink "Sound/register"}}{{/crossLink}} method.  This is only used if
-		 * a value is not provided.
+		 * This is no longer needed as we are now using object pooling for tags.
 		 *
 		 * <b>NOTE this property only exists as a limitation of HTML audio.</b>
 		 * @property defaultNumChannels
 		 * @type {Number}
 		 * @default 2
 		 * @since 0.4.0
+		 * @deprecated
 		 */
 		this.defaultNumChannels = 2;
 
@@ -122,7 +120,7 @@ this.createjs = this.createjs || {};
 
 // Static Properties
 	/**
-	 * The maximum number of instances that can be loaded and played. This is a browser limitation, primarily limited to IE9.
+	 * The maximum number of instances that can be loaded or played. This is a browser limitation, primarily limited to IE9.
 	 * The actual number varies from browser to browser (and is largely hardware dependant), but this is a safe estimate.
 	 * Audio sprites work around this limitation.
 	 * @property MAX_INSTANCES
@@ -239,9 +237,9 @@ this.createjs = this.createjs || {};
 
 
 // public methods
-	p.register = function (loadItem, instances) {
+	p.register = function (loadItem) {
 		var tag = createjs.HTMLAudioTagPool.get(loadItem.src);
-		var loader = this.AbstractPlugin_register(loadItem, instances);
+		var loader = this.AbstractPlugin_register(loadItem);
 		loader.setTag(tag);
 
 		return loader;