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.
Fields borrowed from class minplayer.players.base:
mediaFile
Fields borrowed from class minplayer.display:
onResize
Fields borrowed from class minplayer.plugin:
context, lock, name, options, pluginReady, queue, triggered
Method Summary
Method Attributes Method Name and Description
<static>  
minplayer.players.vimeo.canPlay(file)
 
 
getDuration(callback)
<static>  
minplayer.players.vimeo.getMediaId(file)
Return the ID for a provided media file.
<static>  
minplayer.players.vimeo.getPriority()
 
getVolume(callback)
 
onReady(player_id)
 
 
play()
 
Checks to see if this player can be found.
 
 
seek(pos)
 
setVolume(vol)
 
stop()
Methods borrowed from class minplayer.players.base:
clear, construct, destroy, getBytesLoaded, getBytesStart, getBytesTotal, getCurrentTime, getElements, getPlayer, hasPlayLoader, isReady, load, onComplete, onError, onLoaded, onPaused, onPlaying, onWaiting, seekRelative, setVolumeRelative
Methods borrowed from class minplayer.display:
fullscreen, fullScreenElement, getDisplay, getScaledRect, isFullScreen, isValid, toggleFullScreen
Methods borrowed from class minplayer.plugin:
addPlugin, bind, checkQueue, get, poll, ready, trigger, 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.
Method Detail
<static> {boolean} minplayer.players.vimeo.canPlay(file)
Parameters:
file
Returns:
{boolean} If this player can play this media type.
See:
minplayer.players.base#canPlay

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

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

<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> {number} minplayer.players.vimeo.getPriority()
Returns:
{number} The priority of this media player.
See:
minplayer.players.base#getPriority

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

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

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

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

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

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

seek(pos)
Parameters:
pos
See:
minplayer.players.base#seek

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

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

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Mar 23 2012 10:16:35 GMT-0700 (PDT)