JsDoc Reference - minplayer.players.youtube in HTML5 Media 7
Extends
minplayer.players.base.
The YouTube media player.
Defined in: minplayer.players.youtube.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
minplayer.players.youtube(context, options, queue)
|
| Field Attributes | Field Name and Description |
|---|---|
|
Reset the constructor.
|
|
|
The quality of the YouTube stream.
|
- Fields borrowed from class minplayer.players.base:
- mediaFile
- Fields borrowed from class minplayer.display:
- onResize
- Fields borrowed from class minplayer.plugin:
- active, context, lock, name, options, pluginReady, queue, triggered
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
minplayer.players.youtube.canPlay(file)
|
|
create()
|
|
|
getBytesLoaded(callback)
|
|
|
getBytesStart(callback)
|
|
|
getBytesTotal(callback)
|
|
|
getCurrentTime(callback)
|
|
|
getDuration(callback)
|
|
| <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.getPriority(file)
|
|
getVolume(callback)
|
|
|
Determines if the player should show the controller.
|
|
|
hasPlayLoader(preview)
Determines if the player should show the playloader.
|
|
|
load(file)
|
|
|
onPlayerStateChange(event)
Called when the player state changes.
|
|
|
onQualityChange(newQuality)
Called when the player quality changes.
|
|
|
onReady(event)
Called when an error occurs.
|
|
|
pause()
|
|
|
play()
|
|
|
Checks to see if this player can be found.
|
|
|
seek(pos)
|
|
|
setPlayerState(playerState)
Translates the player state for the YouTube API player.
|
|
|
setVolume(vol)
|
|
|
stop()
|
- Methods borrowed from class minplayer.players.base:
- addPlayer, clear, destroy, getElements, getPlayer, getValue, isReady, onComplete, onError, onLoaded, onPaused, onPlaying, onWaiting, reset, seekRelative, setVolumeRelative
- Methods borrowed from class minplayer.display:
- fullscreen, fullScreenElement, getDisplay, getScaledRect, hide, isFullScreen, onFocus, toggleFullScreen
- Methods borrowed from class minplayer.plugin:
- addPlugin, bind, checkQueue, get, isValid, poll, ready, trigger, 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:
- file
- Returns:
- {boolean} If this player can play this media type.
- See:
- minplayer.players.base#canPlay
construct()
- See:
- minplayer.plugin.construct
{object}
create()
- Returns:
- {object} The media player entity.
getBytesLoaded(callback)
- Parameters:
- callback
- See:
- minplayer.players.base#getBytesLoaded.
getBytesStart(callback)
- Parameters:
- callback
- See:
- minplayer.players.base#getBytesStart.
getBytesTotal(callback)
- Parameters:
- callback
- See:
- minplayer.players.base#getBytesTotal.
getCurrentTime(callback)
- Parameters:
- callback
getDuration(callback)
- Parameters:
- callback
- See:
- minplayer.players.base#getDuration.
<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>
{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
getVolume(callback)
- Parameters:
- callback
{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.
{boolean}
load(file)
- Parameters:
- file
- Returns:
- {boolean} If this action was performed.
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.
{boolean}
pause()
- Returns:
- {boolean} If this action was performed.
{boolean}
play()
- Returns:
- {boolean} If this action was performed.
{bool}
playerFound()
Checks to see if this player can be found.
- Returns:
- {bool} TRUE - Player is found, FALSE - otherwise.
{boolean}
seek(pos)
- Parameters:
- pos
- Returns:
- {boolean} If this action was performed.
setPlayerState(playerState)
Translates the player state for the YouTube API player.
- Parameters:
- {number} playerState
- The YouTube player state.
{boolean}
setVolume(vol)
- Parameters:
- vol
- Returns:
- {boolean} If this action was performed.
{boolean}
stop()
- Returns:
- {boolean} If this action was performed.
Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 04 2012 19:54:20 GMT-0700 (PDT)
File
player/doc/symbols/minplayer.players.youtube.htmlView source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>JsDoc Reference - minplayer.players.youtube</title>
<style type="text/css">
/* default.css */
body
{
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
width: 800px;
}
.header
{
clear: both;
background-color: #ccc;
padding: 8px;
}
h1
{
font-size: 150%;
font-weight: bold;
padding: 0;
margin: 1em 0 0 .3em;
}
hr
{
border: none 0;
border-top: 1px solid #7F8FB1;
height: 1px;
}
pre.code
{
display: block;
padding: 8px;
border: 1px dashed #ccc;
}
#index
{
margin-top: 24px;
float: left;
width: 160px;
position: absolute;
left: 8px;
background-color: #F3F3F3;
padding: 8px;
}
#content
{
margin-left: 190px;
width: 600px;
}
.classList
{
list-style-type: none;
padding: 0;
margin: 0 0 0 8px;
font-family: arial, sans-serif;
font-size: 1em;
overflow: auto;
}
.classList li
{
padding: 0;
margin: 0 0 8px 0;
}
.summaryTable { width: 100%; }
h1.classTitle
{
font-size:170%;
line-height:130%;
}
h2 { font-size: 110%; }
caption, div.sectionTitle
{
background-color: #7F8FB1;
color: #fff;
font-size:130%;
text-align: left;
padding: 2px 6px 2px 6px;
border: 1px #7F8FB1 solid;
}
div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }
.summaryTable td
{
vertical-align: top;
padding: 4px;
border-bottom: 1px #7F8FB1 solid;
border-right: 1px #7F8FB1 solid;
}
/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
border-left: 1px #7F8FB1 solid;
width: 140px;
text-align: right;
}
td.attributes, .fixedFont
{
line-height: 15px;
color: #002EBE;
font-family: "Courier New",Courier,monospace;
font-size: 13px;
}
.summaryTable td.nameDescription
{
text-align: left;
font-size: 13px;
line-height: 15px;
}
.summaryTable td.nameDescription, .description
{
line-height: 15px;
padding: 4px;
padding-left: 4px;
}
.summaryTable { margin-bottom: 8px; }
ul.inheritsList
{
list-style: square;
margin-left: 20px;
padding-left: 0;
}
.detailList {
margin-left: 20px;
line-height: 15px;
}
.detailList dt { margin-left: 20px; }
.detailList .heading
{
font-weight: bold;
padding-bottom: 6px;
margin-left: 0;
}
.light, td.attributes, .light a:link, .light a:visited
{
color: #777;
font-style: italic;
}
.fineprint
{
text-align: right;
font-size: 10px;
}
</style>
</head>
<body>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div id="header">
</div>
<!-- end static/header.html -->
<!-- ============================== classes index ============================ -->
<div id="index">
<!-- begin publish.classesIndex -->
<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
<li><a href="../symbols/jQuery.fn.minplayer.html">jQuery.fn.minplayer</a></li>
<li><a href="../symbols/minplayer.async.html">minplayer.async</a></li>
<li><a href="../symbols/minplayer.compatibility.html">minplayer.compatibility</a></li>
<li><a href="../symbols/minplayer.display.html">minplayer.display</a></li>
<li><a href="../symbols/minplayer.file.html">minplayer.file</a></li>
<li><a href="../symbols/minplayer.flags.html">minplayer.flags</a></li>
<li><a href="../symbols/minplayer.image.html">minplayer.image</a></li>
<li><a href="../symbols/minplayer.players.base.html">minplayer.players.base</a></li>
<li><a href="../symbols/minplayer.players.flash.html">minplayer.players.flash</a></li>
<li><a href="../symbols/minplayer.players.html5.html">minplayer.players.html5</a></li>
<li><a href="../symbols/minplayer.players.minplayer.html">minplayer.players.minplayer</a></li>
<li><a href="../symbols/minplayer.players.vimeo.html">minplayer.players.vimeo</a></li>
<li><a href="../symbols/minplayer.players.youtube.html">minplayer.players.youtube</a></li>
<li><a href="../symbols/minplayer.plugin.html">minplayer.plugin</a></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Class minplayer.players.youtube
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br />Extends
<a href="../symbols/minplayer.players.base.html">minplayer.players.base</a>.<br />
The YouTube media player.
<br /><i>Defined in: </i> <a href="../symbols/src/src_minplayer.players.youtube.js.html">minplayer.players.youtube.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class minplayer.players.youtube.">
<caption>Class Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/minplayer.players.youtube.html#constructor">minplayer.players.youtube</a></b>(context, options, queue)
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class minplayer.players.youtube.">
<caption>Field Summary</caption>
<thead>
<tr>
<th scope="col">Field Attributes</th>
<th scope="col">Field Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/minplayer.players.youtube.html#constructor">constructor</a></b>
</div>
<div class="description">Reset the constructor.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/minplayer.players.youtube.html#quality">quality</a></b>
</div>
<div class="description">The quality of the YouTube stream.</div>
</td>
</tr>
</tbody>
</table>
<dl class="inheritsList">
<dt>Fields borrowed from class <a href="../symbols/minplayer.players.base.html">minplayer.players.base</a>: </dt><dd><a href="../symbols/minplayer.players.base.html#mediaFile">mediaFile</a></dd><dt>Fields borrowed from class <a href="../symbols/minplayer.display.html">minplayer.display</a>: </dt><dd><a href="../symbols/minplayer.display.html#onResize">onResize</a></dd><dt>Fields borrowed from class <a href="../symbols/minplayer.plugin.html">minplayer.plugin</a>: </dt><dd><a href="../symbols/minplayer.plugin.html#active">active</a>, <a href="../symbols/minplayer.plugin.html#context">context</a>, <a href="../symbols/minplayer.plugin.html#lock">lock</a>, <a href="../symbols/minplayer.plugin.html#name">name</a>, <a href="../symbols/minplayer.plugin.html#options">options</a>, <a href="../symbols/minplayer.plugin.html#pluginReady">pluginReady</a>, <a href="../symbols/minplayer.plugin.html#queue">queue</a>, <a href="../symbols/minplayer.plugin.html#triggered">triggered</a></dd>
</dl>
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class minplayer.players.youtube.">
<caption>Method Summary</caption>
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">minplayer.players.youtube.<b><a href="../symbols/minplayer.players.youtube.html#.canPlay">canPlay</a></b>(file)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#construct">construct</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#create">create</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#getBytesLoaded">getBytesLoaded</a></b>(callback)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#getBytesStart">getBytesStart</a></b>(callback)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#getBytesTotal">getBytesTotal</a></b>(callback)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#getCurrentTime">getCurrentTime</a></b>(callback)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#getDuration">getDuration</a></b>(callback)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">minplayer.players.youtube.<b><a href="../symbols/minplayer.players.youtube.html#.getImage">getImage</a></b>(file, type, callback)
</div>
<div class="description">Returns a preview image for this media player.</div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">minplayer.players.youtube.<b><a href="../symbols/minplayer.players.youtube.html#.getMediaId">getMediaId</a></b>(file)
</div>
<div class="description">Return the ID for a provided media file.</div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">minplayer.players.youtube.<b><a href="../symbols/minplayer.players.youtube.html#.getPriority">getPriority</a></b>(file)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#getVolume">getVolume</a></b>(callback)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#hasController">hasController</a></b>()
</div>
<div class="description">Determines if the player should show the controller.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#hasPlayLoader">hasPlayLoader</a></b>(preview)
</div>
<div class="description">Determines if the player should show the playloader.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#load">load</a></b>(file)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#onPlayerStateChange">onPlayerStateChange</a></b>(event)
</div>
<div class="description">Called when the player state changes.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#onQualityChange">onQualityChange</a></b>(newQuality)
</div>
<div class="description">Called when the player quality changes.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#onReady">onReady</a></b>(event)
</div>
<div class="description">Called when an error occurs.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#pause">pause</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#play">play</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#playerFound">playerFound</a></b>()
</div>
<div class="description">Checks to see if this player can be found.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#seek">seek</a></b>(pos)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#setPlayerState">setPlayerState</a></b>(playerState)
</div>
<div class="description">Translates the player state for the YouTube API player.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#setVolume">setVolume</a></b>(vol)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/minplayer.players.youtube.html#stop">stop</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<dl class="inheritsList">
<dt>Methods borrowed from class <a href="../symbols/minplayer.players.base.html">minplayer.players.base</a>: </dt><dd><a href="../symbols/minplayer.players.base.html#addPlayer">addPlayer</a>, <a href="../symbols/minplayer.players.base.html#clear">clear</a>, <a href="../symbols/minplayer.players.base.html#destroy">destroy</a>, <a href="../symbols/minplayer.players.base.html#getElements">getElements</a>, <a href="../symbols/minplayer.players.base.html#getPlayer">getPlayer</a>, <a href="../symbols/minplayer.players.base.html#getValue">getValue</a>, <a href="../symbols/minplayer.players.base.html#isReady">isReady</a>, <a href="../symbols/minplayer.players.base.html#onComplete">onComplete</a>, <a href="../symbols/minplayer.players.base.html#onError">onError</a>, <a href="../symbols/minplayer.players.base.html#onLoaded">onLoaded</a>, <a href="../symbols/minplayer.players.base.html#onPaused">onPaused</a>, <a href="../symbols/minplayer.players.base.html#onPlaying">onPlaying</a>, <a href="../symbols/minplayer.players.base.html#onWaiting">onWaiting</a>, <a href="../symbols/minplayer.players.base.html#reset">reset</a>, <a href="../symbols/minplayer.players.base.html#seekRelative">seekRelative</a>, <a href="../symbols/minplayer.players.base.html#setVolumeRelative">setVolumeRelative</a></dd><dt>Methods borrowed from class <a href="../symbols/minplayer.display.html">minplayer.display</a>: </dt><dd><a href="../symbols/minplayer.display.html#fullscreen">fullscreen</a>, <a href="../symbols/minplayer.display.html#fullScreenElement">fullScreenElement</a>, <a href="../symbols/minplayer.display.html#getDisplay">getDisplay</a>, <a href="../symbols/minplayer.display.html#getScaledRect">getScaledRect</a>, <a href="../symbols/minplayer.display.html#hide">hide</a>, <a href="../symbols/minplayer.display.html#isFullScreen">isFullScreen</a>, <a href="../symbols/minplayer.display.html#onFocus">onFocus</a>, <a href="../symbols/minplayer.display.html#toggleFullScreen">toggleFullScreen</a></dd><dt>Methods borrowed from class <a href="../symbols/minplayer.plugin.html">minplayer.plugin</a>: </dt><dd><a href="../symbols/minplayer.plugin.html#addPlugin">addPlugin</a>, <a href="../symbols/minplayer.plugin.html#bind">bind</a>, <a href="../symbols/minplayer.plugin.html#checkQueue">checkQueue</a>, <a href="../symbols/minplayer.plugin.html#get">get</a>, <a href="../symbols/minplayer.plugin.html#isValid">isValid</a>, <a href="../symbols/minplayer.plugin.html#poll">poll</a>, <a href="../symbols/minplayer.plugin.html#ready">ready</a>, <a href="../symbols/minplayer.plugin.html#trigger">trigger</a>, <a href="../symbols/minplayer.plugin.html#unbind">unbind</a></dd>
</dl>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
<b>minplayer.players.youtube</b>(context, options, queue)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{object}</span> <b>context</b>
</dt>
<dd>The jQuery context.</dd>
<dt>
<span class="light fixedFont">{object}</span> <b>options</b>
</dt>
<dd>This components options.</dd>
<dt>
<span class="light fixedFont">{object}</span> <b>queue</b>
</dt>
<dd>The event queue to pass events around.</dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<div class="sectionTitle">
Field Detail
</div>
<a name="constructor"> </a>
<div class="fixedFont">
<b>constructor</b>
</div>
<div class="description">
Reset the constructor.
</div>
<hr />
<a name="quality"> </a>
<div class="fixedFont">
<b>quality</b>
</div>
<div class="description">
The quality of the YouTube stream.
</div>
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name=".canPlay"> </a>
<div class="fixedFont"><static>
<span class="light">{boolean}</span>
<span class="light">minplayer.players.youtube.</span><b>canPlay</b>(file)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>file</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> If this player can play this media type.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>minplayer.players.base#canPlay</dd>
</dl>
<hr />
<a name="construct"> </a>
<div class="fixedFont">
<b>construct</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>minplayer.plugin.construct</dd>
</dl>
<hr />
<a name="create"> </a>
<div class="fixedFont">
<span class="light">{object}</span>
<b>create</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{object}</span> The media player entity.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#create">minplayer.players.base#create</a></dd>
</dl>
<hr />
<a name="getBytesLoaded"> </a>
<div class="fixedFont">
<b>getBytesLoaded</b>(callback)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>callback</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>minplayer.players.base#getBytesLoaded.</dd>
</dl>
<hr />
<a name="getBytesStart"> </a>
<div class="fixedFont">
<b>getBytesStart</b>(callback)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>callback</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>minplayer.players.base#getBytesStart.</dd>
</dl>
<hr />
<a name="getBytesTotal"> </a>
<div class="fixedFont">
<b>getBytesTotal</b>(callback)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>callback</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>minplayer.players.base#getBytesTotal.</dd>
</dl>
<hr />
<a name="getCurrentTime"> </a>
<div class="fixedFont">
<b>getCurrentTime</b>(callback)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>callback</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#getCurrentTime">minplayer.players.base#getCurrentTime</a></dd>
</dl>
<hr />
<a name="getDuration"> </a>
<div class="fixedFont">
<b>getDuration</b>(callback)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>callback</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>minplayer.players.base#getDuration.</dd>
</dl>
<hr />
<a name=".getImage"> </a>
<div class="fixedFont"><static>
<span class="light">minplayer.players.youtube.</span><b>getImage</b>(file, type, callback)
</div>
<div class="description">
Returns a preview image for this media player.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{object}</span> <b>file</b>
</dt>
<dd>A <a href="../symbols/minplayer.file.html">minplayer.file</a> object.</dd>
<dt>
<span class="light fixedFont">{string}</span> <b>type</b>
</dt>
<dd>The type of image.</dd>
<dt>
<span class="light fixedFont">{function}</span> <b>callback</b>
</dt>
<dd>Called when the image is retrieved.</dd>
</dl>
<hr />
<a name=".getMediaId"> </a>
<div class="fixedFont"><static>
<span class="light">{string}</span>
<span class="light">minplayer.players.youtube.</span><b>getMediaId</b>(file)
</div>
<div class="description">
Return the ID for a provided media file.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{object}</span> <b>file</b>
</dt>
<dd>A <a href="../symbols/minplayer.file.html">minplayer.file</a> object.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{string}</span> The ID for the provided media.</dd>
</dl>
<hr />
<a name=".getPriority"> </a>
<div class="fixedFont"><static>
<span class="light">{number}</span>
<span class="light">minplayer.players.youtube.</span><b>getPriority</b>(file)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{object}</span> <b>file</b>
</dt>
<dd>A <a href="../symbols/minplayer.file.html">minplayer.file</a> object.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{number}</span> The priority of this media player.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>minplayer.players.base#getPriority</dd>
</dl>
<hr />
<a name="getVolume"> </a>
<div class="fixedFont">
<b>getVolume</b>(callback)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>callback</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#getVolume">minplayer.players.base#getVolume</a></dd>
</dl>
<hr />
<a name="hasController"> </a>
<div class="fixedFont">
<span class="light">{bool}</span>
<b>hasController</b>()
</div>
<div class="description">
Determines if the player should show the controller.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{bool}</span> If this player implements its own playLoader.</dd>
</dl>
<hr />
<a name="hasPlayLoader"> </a>
<div class="fixedFont">
<span class="light">{bool}</span>
<b>hasPlayLoader</b>(preview)
</div>
<div class="description">
Determines if the player should show the playloader.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>preview</b>
</dt>
<dd>The preview image.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{bool}</span> If this player implements its own playLoader.</dd>
</dl>
<hr />
<a name="load"> </a>
<div class="fixedFont">
<span class="light">{boolean}</span>
<b>load</b>(file)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>file</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> If this action was performed.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#load">minplayer.players.base#load</a></dd>
</dl>
<hr />
<a name="onPlayerStateChange"> </a>
<div class="fixedFont">
<b>onPlayerStateChange</b>(event)
</div>
<div class="description">
Called when the player state changes.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{object}</span> <b>event</b>
</dt>
<dd>A JavaScript Event.</dd>
</dl>
<hr />
<a name="onQualityChange"> </a>
<div class="fixedFont">
<b>onQualityChange</b>(newQuality)
</div>
<div class="description">
Called when the player quality changes.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>newQuality</b>
</dt>
<dd>The new quality for the change.</dd>
</dl>
<hr />
<a name="onReady"> </a>
<div class="fixedFont">
<b>onReady</b>(event)
</div>
<div class="description">
Called when an error occurs.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>event</b>
</dt>
<dd>The onReady event that was triggered.</dd>
</dl>
<hr />
<a name="pause"> </a>
<div class="fixedFont">
<span class="light">{boolean}</span>
<b>pause</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> If this action was performed.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#pause">minplayer.players.base#pause</a></dd>
</dl>
<hr />
<a name="play"> </a>
<div class="fixedFont">
<span class="light">{boolean}</span>
<b>play</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> If this action was performed.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#play">minplayer.players.base#play</a></dd>
</dl>
<hr />
<a name="playerFound"> </a>
<div class="fixedFont">
<span class="light">{bool}</span>
<b>playerFound</b>()
</div>
<div class="description">
Checks to see if this player can be found.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{bool}</span> TRUE - Player is found, FALSE - otherwise.</dd>
</dl>
<hr />
<a name="seek"> </a>
<div class="fixedFont">
<span class="light">{boolean}</span>
<b>seek</b>(pos)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>pos</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> If this action was performed.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#seek">minplayer.players.base#seek</a></dd>
</dl>
<hr />
<a name="setPlayerState"> </a>
<div class="fixedFont">
<b>setPlayerState</b>(playerState)
</div>
<div class="description">
Translates the player state for the YouTube API player.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>playerState</b>
</dt>
<dd>The YouTube player state.</dd>
</dl>
<hr />
<a name="setVolume"> </a>
<div class="fixedFont">
<span class="light">{boolean}</span>
<b>setVolume</b>(vol)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>vol</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> If this action was performed.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#setVolume">minplayer.players.base#setVolume</a></dd>
</dl>
<hr />
<a name="stop"> </a>
<div class="fixedFont">
<span class="light">{boolean}</span>
<b>stop</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> If this action was performed.</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/minplayer.players.base.html#stop">minplayer.players.base#stop</a></dd>
</dl>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Oct 04 2012 19:54:20 GMT-0700 (PDT)
</div>
</body>
</html>