watson-speech
Version:
IBM Watson Speech to Text and Text to Speech SDK for web browsers.
1,079 lines (232 loc) • 14.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: watson-speech/speech-to-text</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">Module: watson-speech/speech-to-text</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>IBM Watson Speech to Text JavaScript SDK</p>
<p>The primary methods for interacting with the Speech to Text JS SDK are:</p>
<ul>
<li><code>recognizeMicrophone()</code> for live microphone input</li>
<li><code>recognizeFile()</code> for file <code><input></code>'s and other data sources (e.g. a Blob loaded via AJAX)</li>
</ul>
<p>However, the underlying streams and utils that they use are also exposed for advanced usage.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line3">line 3</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".Buffer"><span class="type-signature">(static) </span>Buffer<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line75">line 75</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://nodejs.org/api/buffer.html">https://nodejs.org/api/buffer.html</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".FilePlayer"><span class="type-signature">(static) </span>FilePlayer<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line41">line 41</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="FilePlayer.html">FilePlayer</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".FormatStream"><span class="type-signature">(static) </span>FormatStream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line45">line 45</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="FormatStream.html">FormatStream</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".getModels"><span class="type-signature">(static) </span>getModels<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line28">line 28</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="module-watson-speech_speech-to-text_get-models.html">module:watson-speech/speech-to-text/get-models</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".getUserMedia"><span class="type-signature">(static) </span>getUserMedia<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line67">line 67</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://www.npmjs.com/package/get-user-media-promise">https://www.npmjs.com/package/get-user-media-promise</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".MicrophoneStream"><span class="type-signature">(static) </span>MicrophoneStream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line71">line 71</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://www.npmjs.com/package/microphone-stream">https://www.npmjs.com/package/microphone-stream</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".recognizeFile"><span class="type-signature">(static) </span>recognizeFile<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line24">line 24</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>module:watson-speech/speech-to-text/recognize-blob</li>
</ul>
</dd>
</dl>
<h4 class="name" id=".recognizeMicrophone"><span class="type-signature">(static) </span>recognizeMicrophone<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line20">line 20</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="module-watson-speech_speech-to-text_recognize-microphone.html">module:watson-speech/speech-to-text/recognize-microphone</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".RecognizeStream"><span class="type-signature">(static) </span>RecognizeStream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line37">line 37</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="RecognizeStream.html">RecognizeStream</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".ResultStream"><span class="type-signature">(static) </span>ResultStream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line53">line 53</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="ResultStream.html">ResultStream</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".SpeakerStream"><span class="type-signature">(static) </span>SpeakerStream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line57">line 57</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="SpeakerStream.html">SpeakerStream</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".TimingStream"><span class="type-signature">(static) </span>TimingStream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line49">line 49</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="TimingStream.html">TimingStream</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".WebAudioL16Stream"><span class="type-signature">(static) </span>WebAudioL16Stream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line33">line 33</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="WebAudioL16Stream.html">WebAudioL16Stream</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id=".WritableElementStream"><span class="type-signature">(static) </span>WritableElementStream<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="speech-to-text_index.js.html">speech-to-text/index.js</a>, <a href="speech-to-text_index.js.html#line61">line 61</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="WritableElementStream.html">WritableElementStream</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_get-models.html">watson-speech/speech-to-text/get-models</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="RecognizeStream.html">RecognizeStream</a></li><li><a href="ResultStream.html">ResultStream</a></li><li><a href="SpeakerStream.html">SpeakerStream</a></li><li><a href="TimingStream.html">TimingStream</a></li><li><a href="UrlPlayer.html">UrlPlayer</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:data">data</a></li><li><a href="RecognizeStream.html#event:error">error</a></li><li><a href="RecognizeStream.html#event:listening">listening</a></li><li><a href="RecognizeStream.html#event:message">message</a></li><li><a href="RecognizeStream.html#event:open">open</a></li><li><a href="RecognizeStream.html#event:send-data">send-data</a></li><li><a href="RecognizeStream.html#event:send-json">send-json</a></li><li><a href="RecognizeStream.html#event:stop">stop</a></li><li><a href="SpeakerStream.html#event:data">data</a></li></ul><h3>Global</h3><ul><li><a href="global.html#getContentTypeFromFile">getContentTypeFromFile</a></li><li><a href="global.html#playFile">playFile</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Feb 21 2017 17:41:51 GMT+0000 (UTC)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>