Skip to content

Commit

Permalink
Removed the deprecated capabilities method (in favour of the getter/p…
Browse files Browse the repository at this point in the history
…roperty)
  • Loading branch information
lannymcnie committed Jun 1, 2017
1 parent e1ad346 commit 41c8c43
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 35 deletions.
28 changes: 0 additions & 28 deletions src/soundjs/Sound.js
Original file line number Diff line number Diff line change
Expand Up @@ -812,34 +812,6 @@ this.createjs = this.createjs || {};
return (s.activePlugin != null);
};

/**
* Deprecated, please use {{#crossLink "Sound/capabilities:property"}}{{/crossLink}} instead.
*
* @method getCapabilities
* @return {Object} An object containing the capabilities of the active plugin.
* @static
* @deprecated
*/
s.getCapabilities = function () {
if (s.activePlugin == null) {return null;}
return s.activePlugin._capabilities;
};

/**
* Deprecated, please use {{#crossLink "Sound/capabilities:property"}}{{/crossLink}} instead.
*
* @method getCapability
* @param {String} key The capability to retrieve
* @return {Number|Boolean} The value of the capability.
* @static
* @see getCapabilities
* @deprecated
*/
s.getCapability = function (key) {
if (s.activePlugin == null) {return null;}
return s.activePlugin._capabilities[key];
};

/**
* Process manifest items from <a href="http://preloadjs.com" target="_blank">PreloadJS</a>. This method is intended
* for usage by a plugin, and not for direct interaction.
Expand Down
4 changes: 2 additions & 2 deletions src/soundjs/cordovaaudio/CordovaAudioPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ this.createjs = this.createjs || {};

/**
* The capabilities of the plugin. This is generated via the {{#crossLink "CordovaAudioPlugin/_generateCapabilities"}}{{/crossLink}}
* method. Please see the Sound {{#crossLink "Sound/getCapabilities"}}{{/crossLink}} method for an overview of all
* method. Please see the Sound {{#crossLink "Sound/capabilities:property"}}{{/crossLink}} method for an overview of all
* of the available properties.
* @property _capabilities
* @type {Object}
Expand All @@ -113,7 +113,7 @@ this.createjs = this.createjs || {};
};

/**
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/getCapabilities"}}{{/crossLink}}
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/capabilities:property"}}{{/crossLink}}
* method for an overview of plugin capabilities.
* @method _generateCapabilities
* @static
Expand Down
4 changes: 2 additions & 2 deletions src/soundjs/flashaudio/FlashAudioPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ this.createjs = this.createjs || {};

/**
* The capabilities of the plugin. This is generated via the {{#crossLink "WebAudioPlugin/_generateCapabilities"}}{{/crossLink}}
* method. Please see the Sound {{#crossLink "Sound/getCapabilities"}}{{/crossLink}} method for a list of available
* method. Please see the Sound {{#crossLink "Sound/capabilities:property"}}{{/crossLink}} method for a list of available
* capabilities.
* @property _capabilities
* @type {Object}
Expand Down Expand Up @@ -240,7 +240,7 @@ this.createjs = this.createjs || {};
};

/**
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/getCapabilities"}}{{/crossLink}}
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/capabilities:property"}}{{/crossLink}}
* method for an overview of plugin capabilities.
* @method _generateCapabilities
* @static
Expand Down
4 changes: 2 additions & 2 deletions src/soundjs/htmlaudio/HTMLAudioPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ this.createjs = this.createjs || {};

/**
* The capabilities of the plugin. This is generated via the {{#crossLink "HTMLAudioPlugin/_generateCapabilities"}}{{/crossLink}}
* method. Please see the Sound {{#crossLink "Sound/getCapabilities"}}{{/crossLink}} method for an overview of all
* method. Please see the Sound {{#crossLink "Sound/capabilities:property"}}{{/crossLink}} method for an overview of all
* of the available properties.
* @property _capabilities
* @type {Object}
Expand All @@ -207,7 +207,7 @@ this.createjs = this.createjs || {};
};

/**
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/getCapabilities"}}{{/crossLink}}
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/capabilities:property"}}{{/crossLink}}
* method for an overview of plugin capabilities.
* @method _generateCapabilities
* @static
Expand Down
2 changes: 1 addition & 1 deletion src/soundjs/webaudio/WebAudioPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ this.createjs = this.createjs || {};
};

/**
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/getCapabilities"}}{{/crossLink}}
* Determine the capabilities of the plugin. Used internally. Please see the Sound API {{#crossLink "Sound/capabilities:property"}}{{/crossLink}}
* method for an overview of plugin capabilities.
* @method _generateCapabilities
* @static
Expand Down

0 comments on commit 41c8c43

Please sign in to comment.