videojs-contrib-dash
Version:
A Video.js source-handler providing MPEG-DASH playback.
679 lines (182 loc) • 7.61 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="hook"><span class="type-signature"></span>hook<span class="signature">(type, hook)</span><span class="type-signature"></span></h4>
<div class="description">
Add a function hook to a specific dash lifecycle
</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>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the lifecycle to hook the function to</td>
</tr>
<tr>
<td class="name"><code>hook</code></td>
<td class="type">
<span class="param-type">function</span>
|
<span class="param-type">Array.<function()></span>
</td>
<td class="description last">the function or array of functions to attach</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="videojs-dash.js.html">videojs-dash.js</a>, <a href="videojs-dash.js.html#line325">line 325</a>
</li></ul></dd>
</dl>
<h4 class="name" id="hooks"><span class="type-signature"></span>hooks<span class="signature">(type, hook<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
Get a list of hooks for a specific lifecycle
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">the lifecycle to get hooks from</td>
</tr>
<tr>
<td class="name"><code>hook</code></td>
<td class="type">
<span class="param-type">function</span>
|
<span class="param-type">Array.<function()></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally add a hook tothe lifecycle</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="videojs-dash.js.html">videojs-dash.js</a>, <a href="videojs-dash.js.html#line307">line 307</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
an array of hooks or epty if none
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="removeHook"><span class="type-signature"></span>removeHook<span class="signature">(type, hook)</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Remove a hook from a specific dash lifecycle.
</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>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the lifecycle that the function hooked to</td>
</tr>
<tr>
<td class="name"><code>hook</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">The hooked function to remove</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="videojs-dash.js.html">videojs-dash.js</a>, <a href="videojs-dash.js.html#line336">line 336</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if the function was removed, false if not found
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Html5DashJS.html">Html5DashJS</a></li></ul><h3>Global</h3><ul><li><a href="global.html#hook">hook</a></li><li><a href="global.html#hooks">hooks</a></li><li><a href="global.html#removeHook">removeHook</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Thu Feb 18 2021 14:19:53 GMT-0500 (Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>