Class Index | File Index

Classes


Class minplayer.players.vimeo


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

Class Summary
Constructor Attributes Constructor Name and Description
 
minplayer.players.vimeo(context, options, queue)
Field Summary
Field Attributes Field Name and Description
 
Reset the constructor.
<static>  
minplayer.players.vimeo.nodes
Keep track of loaded nodes from vimeo.
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.vimeo.canPlay(file)
 
Clears the media player.
 
 
<static>  
minplayer.players.vimeo.getImage(file, type, callback)
Returns a preview image for this media player.
<static>  
minplayer.players.vimeo.getMediaId(file)
Return the ID for a provided media file.
<static>  
minplayer.players.vimeo.getNode(file, callback)
Returns information about this vimeo video.
<static>  
minplayer.players.vimeo.getPriority(file)
 
Determines if the player should show the playloader.
 
hasPlayLoader(preview)
Determines if the player should show the playloader.
 
load(file, callback)
 
onReady(player_id)
<static>  
minplayer.players.vimeo.parseNode(item)
Parse a single playlist node.
 
pause(callback)
 
play(callback)
 
 
setVolume(vol, callback)
 
stop(callback)
Methods borrowed from class minplayer.players.base:
addPlayer, defaultOptions, destroy, getBytesLoaded, getBytesStart, getBytesTotal, getCurrentTime, getDuration, getElements, getPlayer, getValue, getVolume, isReady, onComplete, onError, onLoaded, onPaused, onPlaying, onWaiting, parseTime, playerFound, 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.vimeo(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.

<static> minplayer.players.vimeo.nodes
Keep track of loaded nodes from vimeo.
Method Detail
<static> {boolean} minplayer.players.vimeo.canPlay(file)
Parameters:
{object} file
A minplayer.file object.
Returns:
{boolean} If this player can play this media type.
See:
minplayer.players.base#canPlay

clear()
Clears the media player.

construct()
See:
minplayer.plugin.construct

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

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

<static> {number} minplayer.players.vimeo.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 playloader.
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

onReady(player_id)
Parameters:
player_id
See:
minplayer.players.base#onReady

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

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

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

reset()
See:
minplayer.players.base#reset

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)