Class Index | File Index

Classes


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
 
Reset the constructor.
 
The nodes within this playlist.
Fields borrowed from class minplayer.display:
onResize
Fields borrowed from class minplayer.plugin:
active, context, lock, name, options, pluginReady, queue, triggered, uuid
Method Summary
Method Attributes Method Name and Description
 
 
load(page, loadIndex)
Loads a playlist.
 
loadItem(index)
Loads a playlist node.
 
next()
Loads the next item.
 
nextPage(loadIndex)
Loads the next page.
 
prev()
Loads the previous item.
 
prevPage(loadIndex)
Loads the previous page.
 
Refresh the scrollbar.
 
scrollTo(pos, relative)
Wrapper around the scroll scrollTo method.
 
set(playlist, loadIndex)
Sets the playlist.
 
Stores the current playlist state in the playqueue.
Methods borrowed from class minplayer.display:
fullscreen, fullScreenElement, getDisplay, getElements, getScaledRect, hide, isFullScreen, onFocus, showThenHide, toggleFullScreen
Methods borrowed from class minplayer.plugin:
addPlugin, bind, checkQueue, create, destroy, get, isEvent, isValid, poll, ready, trigger, ubind, unbind
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
construct()
See:
minplayer.plugin#construct

{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)
Loads a playlist node.
Parameters:
{number} index
The index of the item you would like to load.
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.

{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.

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Nov 04 2012 11:33:38 GMT-0600 (CST)