Class osmplayer

Extends minplayer.
The main osmplayer class.

Usage:



  // Create a media player.
  var player = jQuery("#player").osmplayer({

  });

Defined in: osmplayer.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	osmplayer(context, options)

Field Summary
Field Attributes	Field Name and Description
	constructor Reset the constructor.
<static>	osmplayer.parser The parser object.
	playQueue The play queue and index.

Method Summary
Method Attributes	Method Name and Description
	addToQueue(file) Adds a file to the play queue.
	construct()
	create(name, base, context) Creates a new plugin within this context.
	defaultOptions(options) Get the default options for this plugin.
	fullScreenElement() Gets the full screen element.
<static>	osmplayer.getImage(mediafiles, type, callback) Returns an image provided image array.
<static>	osmplayer.getNode(node, callback) Returns a node.
	loadNode(node) The load node function.
	playNext() Plays the next media file in the queue.
	reset(callback) Reset the osmplayer.

Class Detail

osmplayer(context, options)

Parameters:
{object} context: The jQuery context.
{object} options: This components options.

Field Detail

constructor

Reset the constructor.

<static> osmplayer.parser

The parser object.
Defined in: osmplayer.parser.default.js.

playQueue

The play queue and index.

Method Detail

{object} addToQueue(file)

Adds a file to the play queue.

Parameters:
{object} file: The file to add to the queue.

Returns:: {object} The file that was added to the queue.

construct()

See:: minplayer.plugin.construct

{object} create(name, base, context)

Creates a new plugin within this context.

Parameters:
{string} name: The name of the plugin you wish to create.
{object} base: The base object for this plugin.
{object} context: The context which you would like to create.

Returns:: {object} The new plugin object.

defaultOptions(options)

Get the default options for this plugin.

Parameters:
{object} options: The default options for this plugin.

{object} fullScreenElement()

Gets the full screen element.

Returns:: {object} The element that will go into fullscreen.

<static> osmplayer.getImage(mediafiles, type, callback)

Returns an image provided image array.

Parameters:
{object} mediafiles: The mediafiles to search within.
{string} type: The type of image to look for.
{function} callback: Called when the image is retrieved.

<static> osmplayer.getNode(node, callback)

Returns a node.

Parameters:
{object} node: The node to get.
{function} callback: Called when the node is retrieved.

{boolean} loadNode(node)

The load node function.

Parameters:
{object} node: A media node object.

Returns:: {boolean} If the node was loaded.

playNext()

Plays the next media file in the queue.

reset(callback)

Reset the osmplayer.

Parameters:
{function} callback: Called when it is done resetting.

Classes

Class osmplayer