Class Index | File Index

Classes


Class minplayer.plugin

The base class for all plugins.
Defined in: minplayer.plugin.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
minplayer.plugin(context, options)
Field Summary
Field Attributes Field Name and Description
<static>  
minplayer.plugin.instances
Static array to keep track of plugin instances.
Method Summary
Method Attributes Method Name and Description
 
addPlugin(name, plugin)
Adds a new plugin to this player.
 
The constructor which is called once the context is set.
 
Destructor.
 
eachPlugin(callback)
Iterate over each plugin.
 
getPlugin(name)
Gets a plugin by name.
 
Loads all of the available plugins.
 
setPlayer(player)
Sets the current media player.
Class Detail
minplayer.plugin(context, options)
Parameters:
{object} context
The jQuery context.
{object} options
This components options.
Field Detail
<static> minplayer.plugin.instances
Static array to keep track of plugin instances.
Method Detail
addPlugin(name, plugin)
Adds a new plugin to this player.
Parameters:
{string} name
The name of this plugin.
{object} plugin
A new plugin object, derived from media.plugin.

construct()
The constructor which is called once the context is set. Any class deriving from the plugin class should place all context dependant functionality within this function instead of the standard constructor function since it is called on object derivation as well as object creation.

destroy()
Destructor.

eachPlugin(callback)
Iterate over each plugin.
Parameters:
{function} callback
Called for each plugin in this player.

{object} getPlugin(name)
Gets a plugin by name.
Parameters:
{string} name
The name of the plugin.
Returns:
{object} The plugin for the provided name.

loadPlugins()
Loads all of the available plugins.

setPlayer(player)
Sets the current media player.
Parameters:
{object} player
The current media player.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 10 2012 02:13:36 GMT+0100 (CET)