videojs-contrib-media-sources
Version:
A Media Source Extensions plugin for video.js
2,361 lines • 24.2 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: MessageHandlers</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">Class: MessageHandlers</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>MessageHandlers<span class="signature">(options)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="MessageHandlers"><span class="type-signature"></span>new MessageHandlers<span class="signature">(options)</span><span class="type-signature"></span></h4>
<div class="description">
All incoming messages route through this hash. If no function exists
to handle an incoming message, then we ignore the message.
</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">the options to initialize with</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="flush"><span class="type-signature"></span>flush<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Forces the pipeline to finish processing the last segment and emit its
results.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="flush"><span class="type-signature"></span>flush<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Forces the pipeline to finish processing the last segment and emit it's
results.
</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>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">event data, not really used</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
initialize our web worker and wire all the events.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
initialize our web worker and wire all the events.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="push"><span class="type-signature"></span>push<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Adds data (a ts segment) to the start of the transmuxer pipeline for
processing.
</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>data</code></td>
<td class="type">
<span class="param-type">ArrayBuffer</span>
</td>
<td class="description last">data to push into the muxer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
<h4 class="name" id="push"><span class="type-signature"></span>push<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Adds data (a ts segment) to the start of the transmuxer pipeline for
processing.
</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>data</code></td>
<td class="type">
<span class="param-type">ArrayBuffer</span>
</td>
<td class="description last">data to push into the muxer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Recreate the transmuxer so that the next segment added via `push`
start with a fresh transmuxer.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line112">line 112</a>
</li></ul></dd>
</dl>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Recreate the transmuxer so that the next segment added via `push`
start with a fresh transmuxer.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setTimestampOffset"><span class="type-signature"></span>setTimestampOffset<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Set the value that will be used as the `baseMediaDecodeTime` time for the
next segment pushed in. Subsequent segments will have their `baseMediaDecodeTime`
set relative to the first based on the PTS values.
</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>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">used to set the timestamp offset in the muxer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line123">line 123</a>
</li></ul></dd>
</dl>
</article>
</section>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>MessageHandlers<span class="signature">(options)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="MessageHandlers"><span class="type-signature"></span>new MessageHandlers<span class="signature">(options)</span><span class="type-signature"></span></h4>
<div class="description">
All incoming messages route through this hash. If no function exists
to handle an incoming message, then we ignore the message.
</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">the options to initialize with</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="flush"><span class="type-signature"></span>flush<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Forces the pipeline to finish processing the last segment and emit its
results.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="flush"><span class="type-signature"></span>flush<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Forces the pipeline to finish processing the last segment and emit it's
results.
</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>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">event data, not really used</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
initialize our web worker and wire all the events.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
initialize our web worker and wire all the events.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="push"><span class="type-signature"></span>push<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Adds data (a ts segment) to the start of the transmuxer pipeline for
processing.
</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>data</code></td>
<td class="type">
<span class="param-type">ArrayBuffer</span>
</td>
<td class="description last">data to push into the muxer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
<h4 class="name" id="push"><span class="type-signature"></span>push<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Adds data (a ts segment) to the start of the transmuxer pipeline for
processing.
</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>data</code></td>
<td class="type">
<span class="param-type">ArrayBuffer</span>
</td>
<td class="description last">data to push into the muxer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Recreate the transmuxer so that the next segment added via `push`
start with a fresh transmuxer.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line112">line 112</a>
</li></ul></dd>
</dl>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Recreate the transmuxer so that the next segment added via `push`
start with a fresh transmuxer.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flash-transmuxer-worker.js.html">flash-transmuxer-worker.js</a>, <a href="flash-transmuxer-worker.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setTimestampOffset"><span class="type-signature"></span>setTimestampOffset<span class="signature">(data)</span><span class="type-signature"></span></h4>
<div class="description">
Set the value that will be used as the `baseMediaDecodeTime` time for the
next segment pushed in. Subsequent segments will have their `baseMediaDecodeTime`
set relative to the first based on the PTS values.
</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>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">used to set the timestamp offset in the muxer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="transmuxer-worker.js.html">transmuxer-worker.js</a>, <a href="transmuxer-worker.js.html#line123">line 123</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FlashMediaSource.html">FlashMediaSource</a></li><li><a href="FlashSourceBuffer.html">FlashSourceBuffer</a></li><li><a href="HtmlMediaSource.html">HtmlMediaSource</a></li><li><a href="MessageHandlers.html">MessageHandlers</a></li><li><a href="VirtualSourceBuffer.html">VirtualSourceBuffer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#abort">abort</a></li><li><a href="global.html#addSourceBuffer">addSourceBuffer</a></li><li><a href="global.html#appendBuffer">appendBuffer</a></li><li><a href="global.html#appendGopInfo_">appendGopInfo_</a></li><li><a href="global.html#endOfStream">endOfStream</a></li><li><a href="global.html#FlashTransmuxerWorker">FlashTransmuxerWorker</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#gopsSafeToAlignWith">gopsSafeToAlignWith</a></li><li><a href="global.html#MediaSource">MediaSource</a></li><li><a href="global.html#open">open</a></li><li><a href="global.html#remove">remove</a></li><li><a href="global.html#removeGopBuffer">removeGopBuffer</a></li><li><a href="global.html#set">set</a></li><li><a href="global.html#supportsNativeMediaSources">supportsNativeMediaSources</a></li><li><a href="global.html#TransmuxerWorker">TransmuxerWorker</a></li><li><a href="global.html#updateGopBuffer">updateGopBuffer</a></li><li><a href="global.html#URL">URL</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Thu Nov 02 2017 12:03:26 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>