videojs-playlist
Version:
Playlist plugin for Video.js
1,346 lines (310 loc) • 13.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="clearTracks"><span class="type-signature"></span>clearTracks<span class="signature">(player)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Removes all remote text tracks from a player.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>player</code></td>
<td class="type">
<span class="param-type">Player</span>
</td>
<td class="description last"><p>The player to clear tracks on</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="play-item.js.html">play-item.js</a>, <a href="play-item.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
<h4 class="name" id="playItem"><span class="type-signature"></span>playItem<span class="signature">(player, item)</span><span class="type-signature"> → {Player}</span></h4>
<div class="description">
<p>Plays an item on a player's playlist.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>player</code></td>
<td class="type">
<span class="param-type">Player</span>
</td>
<td class="description last"><p>The player to play the item on</p></td>
</tr>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>A source from the playlist.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="play-item.js.html">play-item.js</a>, <a href="play-item.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The player that is now playing the item</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Player</span>
</dd>
</dl>
<h4 class="name" id="plugin"><span class="type-signature"></span>plugin<span class="signature">(list, item)</span><span class="type-signature"></span></h4>
<div class="description">
<p>The video.js playlist plugin. Invokes the playlist-maker to create a
playlist function on the specific player.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>list</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>a list of sources</p></td>
</tr>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The index to start at</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">(player)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Resets the auto-advance behavior of a player.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>player</code></td>
<td class="type">
<span class="param-type">Player</span>
</td>
<td class="description last"><p>The player to reset the behavior on</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="auto-advance.js.html">auto-advance.js</a>, <a href="auto-advance.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setReset_"><span class="type-signature"></span>setReset_<span class="signature">(fn)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Used to change the reset function in this module at runtime
This should only be used in tests.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>The function to se the reset to</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="auto-advance.js.html">auto-advance.js</a>, <a href="auto-advance.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setup"><span class="type-signature"></span>setup<span class="signature">(player, delay)</span><span class="type-signature"> → {undefined}</span></h4>
<div class="description">
<p>Sets up auto-advance behavior on a player.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>player</code></td>
<td class="type">
<span class="param-type">Player</span>
</td>
<td class="description last"><p>the current player</p></td>
</tr>
<tr>
<td class="name"><code>delay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The number of seconds to wait before each auto-advance.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="auto-advance.js.html">auto-advance.js</a>, <a href="auto-advance.js.html#line48">line 48</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Used to short circuit function logic</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">undefined</span>
</dd>
</dl>
<h3 class="subsection-title">Events</h3>
<h4 class="name" id="event:playlistsorted">playlistsorted</h4>
<div class="description">
<p>Triggered after the playlist is sorted internally.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="playlist-maker.js.html">playlist-maker.js</a>, <a href="playlist-maker.js.html#line486">line 486</a>
</li></ul></dd>
</dl>
<h4 class="name" id="event:playlistsorted">playlistsorted</h4>
<div class="description">
<p>Triggered after the playlist is sorted internally.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="playlist-maker.js.html">playlist-maker.js</a>, <a href="playlist-maker.js.html#line515">line 515</a>
</li></ul></dd>
</dl>
<h4 class="name" id="event:playlistsorted">playlistsorted</h4>
<div class="description">
<p>Triggered after the playlist is sorted internally.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="playlist-maker.js.html">playlist-maker.js</a>, <a href="playlist-maker.js.html#line571">line 571</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Events</h3><ul><li><a href="global.html#event:playlistsorted">playlistsorted</a></li></ul><h3>Global</h3><ul><li><a href="global.html#clearTracks">clearTracks</a></li><li><a href="global.html#playItem">playItem</a></li><li><a href="global.html#plugin">plugin</a></li><li><a href="global.html#reset">reset</a></li><li><a href="global.html#setReset_">setReset_</a></li><li><a href="global.html#setup">setup</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 25 2018 13:27:02 GMT-0500 (EST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>