Class Index | File Index

Classes


Class minplayer.players.youtube


Extends minplayer.players.base.
The YouTube media player.
Defined in: minplayer.players.youtube.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
minplayer.players.youtube(context, options, queue)
Field Summary
Field Attributes Field Name and Description
 
Reset the constructor.
 
The quality of the YouTube stream.
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.youtube.canPlay(file)
 
 
<static>  
minplayer.players.youtube.getImage(file, type, callback)
Returns a preview image for this media player.
<static>  
minplayer.players.youtube.getMediaId(file)
Return the ID for a provided media file.
<static>  
minplayer.players.youtube.getNode(file, callback)
Returns information about this youtube video.
<static>  
minplayer.players.youtube.getPriority(file)
 
Determines if the player should show the controller.
 
hasPlayLoader(preview)
Determines if the player should show the playloader.
 
load(file, callback)
 
Called when the player state changes.
 
onQualityChange(newQuality)
Called when the player quality changes.
 
onReady(event)
Called when an error occurs.
<static>  
minplayer.players.youtube.parseNode(item)
Parse a single playlist node.
 
pause(callback)
 
play(callback)
 
Checks to see if this player can be found.
 
setPlayerState(playerState)
Translates the player state for the YouTube API player.
 
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, isReady, onComplete, onError, onLoaded, onPaused, onPlaying, onWaiting, parseTime, 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.youtube(context, options, queue)
Parameters:
{object} context
The jQuery context.
{object} options
This components options.
{object} queue
The event queue to pass events around.
Field Detail
constructor
Reset the constructor.

quality
The quality of the YouTube stream.
Method Detail
<static> {boolean} minplayer.players.youtube.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> minplayer.players.youtube.getImage(file, type, callback)
Returns a preview image for this media player.
Parameters:
{object} file
A minplayer.file object.
{string} type
The type of image.
{function} callback
Called when the image is retrieved.

<static> {string} minplayer.players.youtube.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> minplayer.players.youtube.getNode(file, callback)
Returns information about this youtube video.
Parameters:
{object} file
The file to load.
{function} callback
Called when the node is loaded.

<static> {number} minplayer.players.youtube.getPriority(file)
Parameters:
{object} file
A minplayer.file object.
Returns:
{number} The priority of this media player.
See:
minplayer.players.base#getPriority

{bool} hasController()
Determines if the player should show the controller.
Returns:
{bool} If this player implements its own playLoader.

{bool} hasPlayLoader(preview)
Determines if the player should show the playloader.
Parameters:
{string} preview
The preview image.
Returns:
{bool} If this player implements its own playLoader.

load(file, callback)
Parameters:
file
callback
See:
minplayer.players.base#load

onPlayerStateChange(event)
Called when the player state changes.
Parameters:
{object} event
A JavaScript Event.

onQualityChange(newQuality)
Called when the player quality changes.
Parameters:
{string} newQuality
The new quality for the change.

onReady(event)
Called when an error occurs.
Parameters:
{string} event
The onReady event that was triggered.

<static> {object} minplayer.players.youtube.parseNode(item)
Parse a single playlist node.
Parameters:
{object} item
The youtube item.
Returns:
{object} The mediafront node.

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

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

{bool} playerFound()
Checks to see if this player can be found.
Returns:
{bool} TRUE - Player is found, FALSE - otherwise.

setPlayerState(playerState)
Translates the player state for the YouTube API player.
Parameters:
{number} playerState
The YouTube player state.

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)