Class osmplayer.playlist

Extends minplayer.display.
This class creates the playlist functionality for the minplayer.
Defined in: osmplayer.playlist.js.

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

Field Summary
Field Attributes	Field Name and Description
	constructor Reset the constructor.
	nodes The nodes within this playlist.

Method Summary
Method Attributes	Method Name and Description
	addNode(node) Adds a new node to the playlist.
	construct()
	defaultOptions(options) Returns the default options for this plugin.
	load(page, loadIndex) Loads a playlist.
	loadItem(index, autoplay) Loads a playlist node.
	next() Loads the next item.
	nextPage(loadIndex) Loads the next page.
	onAdded(plugin)
	prev() Loads the previous item.
	prevPage(loadIndex) Loads the previous page.
	refreshScroll() Refresh the scrollbar.
	scrollTo(pos, relative) Wrapper around the scroll scrollTo method.
	set(playlist, loadIndex) Sets the playlist.
	setQueue() Stores the current playlist state in the playqueue.

Class Detail

osmplayer.playlist(context, options)

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

Field Detail

constructor

Reset the constructor.

nodes

The nodes within this playlist.

Method Detail

addNode(node)

Adds a new node to the playlist.

Parameters:
{object} node: The node that you would like to add to the playlist.

construct()

See:: minplayer.plugin#construct

defaultOptions(options)

Returns the default options for this plugin.

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

{boolean} load(page, loadIndex)

Loads a playlist.

Parameters:
{integer} page: The page to load.
{integer} loadIndex: The index of the item to load.

Returns:: {boolean} TRUE if loaded, FALSE if not.

{boolean} loadItem(index, autoplay)

Loads a playlist node.

Parameters:
{number} index: The index of the item you would like to load.
autoplay

Returns:: {boolean} TRUE if loaded, FALSE if not.

{boolean} next()

Loads the next item.

Returns:: {boolean} TRUE if loaded, FALSE if not.

{boolean} nextPage(loadIndex)

Loads the next page.

Parameters:
{integer} loadIndex: The index of the item to load.

Returns:: {boolean} TRUE if loaded, FALSE if not.

onAdded(plugin)

Parameters:
plugin

See:: minplayer.plugin.onAdded

{boolean} prev()

Loads the previous item.

Returns:: {boolean} TRUE if loaded, FALSE if not.

{boolean} prevPage(loadIndex)

Loads the previous page.

Parameters:
{integer} loadIndex: The index of the item to load.

Returns:: {boolean} TRUE if loaded, FALSE if not.

refreshScroll()

Refresh the scrollbar.

scrollTo(pos, relative)

Wrapper around the scroll scrollTo method.

Parameters:
{number} pos: The position you would like to set the list.
{boolean} relative: If this is a relative position change.

set(playlist, loadIndex)

Sets the playlist.

Parameters:
{object} playlist: The playlist object.
{integer} loadIndex: The index of the item to load.

setQueue()

Stores the current playlist state in the playqueue.

Classes

Class osmplayer.playlist