watson-speech
Version:
IBM Watson Speech to Text and Text to Speech SDK for web browsers.
796 lines (234 loc) • 12.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: MediaElementAudioStream</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: MediaElementAudioStream</h1>
<section>
<header>
<h2>MediaElementAudioStream</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="MediaElementAudioStream"><span class="type-signature"></span>new MediaElementAudioStream<span class="signature">(element, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Extracts audio from an <code><audio></code> or <code><video></code> element and provides it as a Node.js Readable stream</p>
</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>element</code></td>
<td class="type">
<span class="param-type">HTMLMediaElement</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p><code><audio></code> or <code><video></code> element or CSS selector</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>options</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>bufferSize</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">null</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>buffer size - Mozilla docs recommend leaving this unset for optimal performance</p></td>
</tr>
<tr>
<td class="name"><code>muteSource</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If true, the audio will not be sent back to the source</p></td>
</tr>
<tr>
<td class="name"><code>objectMode</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>emit AudioBuffers w/ the audio + a bit of metadata instead of Node.js Buffers with audio only</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_media-element-audio-stream.js.html">speech-to-text/media-element-audio-stream.js</a>, <a href="speech-to-text_media-element-audio-stream.js.html#line23">line 23</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement">https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement</a></li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createScriptProcessor">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createScriptProcessor</a></li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".toRaw"><span class="type-signature">(static) </span>toRaw<span class="signature">(chunk)</span><span class="type-signature"> → {Float32Array}</span></h4>
<div class="description">
<p>Converts a Buffer back into the raw Float32Array format that browsers use.
Note: this is just a new DataView for the same underlying buffer -
the actual audio data is not copied or changed here.</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>chunk</code></td>
<td class="type">
<span class="param-type">Buffer</span>
</td>
<td class="description last"><p>node-style buffer of audio data from a 'data' event or read() call</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_media-element-audio-stream.js.html">speech-to-text/media-element-audio-stream.js</a>, <a href="speech-to-text_media-element-audio-stream.js.html#line159">line 159</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>raw 32-bit float data view of audio data</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Float32Array</span>
</dd>
</dl>
<h4 class="name" id="~connect"><span class="type-signature">(inner) </span>connect<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Setup script processor to extract audio and also re-connect it via a no-op gain node if desired</p>
<p>Delayed to avoid processing the stream of silence received before the file begins playing</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_media-element-audio-stream.js.html">speech-to-text/media-element-audio-stream.js</a>, <a href="speech-to-text_media-element-audio-stream.js.html#line93">line 93</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~processAudio"><span class="type-signature">(inner) </span>processAudio<span class="signature">(e)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Convert and emit the raw audio data</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>e</code></td>
<td class="type">
<span class="param-type">AudioProcessingEvent</span>
</td>
<td class="description last"><p>https://developer.mozilla.org/en-US/docs/Web/API/AudioProcessingEvent</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_media-element-audio-stream.js.html">speech-to-text/media-element-audio-stream.js</a>, <a href="speech-to-text_media-element-audio-stream.js.html#line65">line 65</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode/onaudioprocess">https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode/onaudioprocess</a></li>
</ul>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-watson-speech.html">watson-speech</a></li><li><a href="module-watson-speech_speech-to-text.html">watson-speech/speech-to-text</a></li><li><a href="module-watson-speech_speech-to-text_recognize-element.html">watson-speech/speech-to-text/recognize-element</a></li><li><a href="module-watson-speech_speech-to-text_recognize-file.html">watson-speech/speech-to-text/recognize-file</a></li><li><a href="module-watson-speech_speech-to-text_recognize-microphone.html">watson-speech/speech-to-text/recognize-microphone</a></li><li><a href="module-watson-speech_text-to-speech.html">watson-speech/text-to-speech</a></li><li><a href="module-watson-speech_text-to-speech_get-voices.html">watson-speech/text-to-speech/get-voices</a></li><li><a href="module-watson-speech_text-to-speech_synthesize.html">watson-speech/text-to-speech/synthesize</a></li></ul><h3>Classes</h3><ul><li><a href="FilePlayer.html">FilePlayer</a></li><li><a href="FormatStream.html">FormatStream</a></li><li><a href="MediaElementAudioStream.html">MediaElementAudioStream</a></li><li><a href="RecognizeStream.html">RecognizeStream</a></li><li><a href="TimingStream.html">TimingStream</a></li><li><a href="WebAudioL16Stream.html">WebAudioL16Stream</a></li><li><a href="WritableElementStream.html">WritableElementStream</a></li></ul><h3>Events</h3><ul><li><a href="RecognizeStream.html#event:close">close</a></li><li><a href="RecognizeStream.html#event:connection-close">connection-close</a></li><li><a href="RecognizeStream.html#event:data">data</a></li><li><a href="RecognizeStream.html#event:error">error</a></li><li><a href="RecognizeStream.html#event:results">results</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Feb 23 2016 22:23:53 GMT+0000 (UTC)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>