Class Index | File Index

Classes


Class minplayer.players.limelight


Extends minplayer.players.base.
The Limelight media player.
Defined in: minplayer.players.limelight.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
minplayer.players.limelight(context, options)
Field Summary
Field Attributes Field Name and Description
 
Reset the constructor.
Fields borrowed from class minplayer.players.base:
mediaFile, readyQueue
Fields borrowed from class minplayer.display:
onResize
Fields borrowed from class minplayer.plugin:
active, context, lock, name, pluginReady, queue, triggered, uuid
Method Summary
Method Attributes Method Name and Description
<static>  
minplayer.players.limelight.canPlay(file)
 
 
<static>  
minplayer.players.limelight.getMediaId(file)
Return the ID for a provided media file.
<static>  
minplayer.players.limelight.getPriority()
 
onMediaUpdate(event, data)
The media update method.
 
pause(callback)
 
play(callback)
 
Register this limelight player so that multiple players can be present on the same page without event collision.
 
search(query)
Perform the Limelight Search Inside.
 
setVolume(vol, callback)
 
stop(callback)
Methods borrowed from class minplayer.players.base:
addPlayer, clear, defaultOptions, destroy, getBytesLoaded, getBytesStart, getBytesTotal, getCurrentTime, getDuration, getElements, getPlayer, getValue, getVolume, hasController, hasPlayLoader, isReady, load, onComplete, onError, onLoaded, onPaused, onPlaying, onReady, onWaiting, parseTime, playerFound, reset, seek, seekRelative, setStartStop, setupPlayer, setVolumeRelative, whenReady
Methods borrowed from class minplayer.display:
fullscreen, fullScreenElement, getDisplay, getScaledRect, hide, initialize, isFullScreen, onFocus, showThenHide, toggleFullScreen
Methods borrowed from class minplayer.plugin:
addPlugin, bind, checkQueue, create, get, isEvent, isValid, onAdded, poll, ready, trigger, ubind, unbind
Class Detail
minplayer.players.limelight(context, options)
Parameters:
{object} context
The jQuery context.
{object} options
This components options.
Field Detail
constructor
Reset the constructor.
Method Detail
<static> {boolean} minplayer.players.limelight.canPlay(file)
Parameters:
{object} file
A minplayer.file object.
Returns:
{boolean} If this player can play this media type.
See:
minplayer.players.base#canPlay

construct()
See:
minplayer.plugin.construct

{object} createPlayer()
Returns:
{object} The media player entity.
See:
minplayer.players.base#create

<static> {string} minplayer.players.limelight.getMediaId(file)
Return the ID for a provided media file.
Parameters:
{object} file
A minplayer.file object.
Returns:
{string} The ID for the provided media.

<static> {number} minplayer.players.limelight.getPriority()
Returns:
{number} The priority of this media player.
See:
minplayer.players.base#getPriority

onMediaUpdate(event, data)
The media update method.
Parameters:
{string} event
The event that was triggered.
{object} data
The event object.

pause(callback)
Parameters:
callback
See:
minplayer.players.base#pause

play(callback)
Parameters:
callback
See:
minplayer.players.base#play

register()
Register this limelight player so that multiple players can be present on the same page without event collision.

search(query)
Perform the Limelight Search Inside.
Parameters:
{string} query
The query to search for.

setVolume(vol, callback)
Parameters:
vol
callback
See:
minplayer.players.base#setVolume

stop(callback)
Parameters:
callback
See:
minplayer.players.base#stop

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Dec 04 2013 21:13:26 GMT-0600 (CST)