watson-speech
Version:
IBM Watson Speech to Text and Text to Speech SDK for web browsers.
2,171 lines (679 loc) • 32 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="getContentTypeFromFile"><span class="type-signature"></span>getContentTypeFromFile<span class="signature">(file)</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
<p>Reads the first few bytes of a binary file and resolves to the content-type if recognized & supported</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>file</code></td>
<td class="type">
<span class="param-type">File</span>
|
<span class="param-type">Blob</span>
</td>
<td class="description last"></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_file-player.js.html">speech-to-text/file-player.js</a>, <a href="speech-to-text_file-player.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="module:watson-speech/speech-to-text/get-models"><span class="type-signature"></span>module:watson-speech/speech-to-text/get-models<span class="signature">(options)</span><span class="type-signature"> → {Promise.<T>}</span></h4>
<div class="description">
<p>Returns a promise that resolves to an array of objects representing the available voice models. Example:</p>
<pre class="prettyprint source lang-js"><code> [{
"url": "https://stream.watsonplatform.net/speech-to-text/api/v1/models/en-UK_BroadbandModel",
"rate": 16000,
"name": "en-UK_BroadbandModel",
"language": "en-UK",
"description": "UK English broadband model."
},
//...
]</code></pre><p> Requires fetch, pollyfill available at https://github.com/github/fetch</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>token</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>auth token</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_get-models.js.html">speech-to-text/get-models.js</a>, <a href="speech-to-text_get-models.js.html#line43">line 43</a>
</li></ul></dd>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul>
<li>define format in @returns statement</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<T></span>
</dd>
</dl>
<h4 class="name" id="module:watson-speech/speech-to-text/recognize-file"><span class="type-signature"></span>module:watson-speech/speech-to-text/recognize-file<span class="signature">(options)</span><span class="type-signature"> → {<a href="RecognizeStream.html">RecognizeStream</a>|<a href="FormatStream.html">FormatStream</a>|<a href="TimingStream.html">TimingStream</a>}</span></h4>
<div class="description">
<p>Create and return a RecognizeStream from a File or Blob
(e.g. from a file <input>, a dtagdrop targe, or an ajax request)</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Also passed to {MediaElementAudioStream} and to {RecognizeStream}</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>token</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Auth Token - see https://github.com/watson-developer-cloud/node-sdk#authorization</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Blob</span>
|
<span class="param-type">File</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>the raw audio data as a Blob or File instance</p></td>
</tr>
<tr>
<td class="name"><code>play</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 a file is set, play it locally as it's being uploaded</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">Boolena</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>pipe the text through a {FormatStream} which performs light formatting. Also controls smart_formatting option unless explicitly set.</p></td>
</tr>
<tr>
<td class="name"><code>realtime</code></td>
<td class="type">
<span class="param-type">Boolena</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
options.play
</td>
<td class="description last"><p>pipe the text through a {TimingStream} which slows the output down to real-time to match the audio playback.</p></td>
</tr>
<tr>
<td class="name"><code>outputElement</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">DOMElement</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>pipe the text to a WriteableElementStream targeting the specified element. Also defaults objectMode to true to enable interim results.</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_recognize-file.js.html">speech-to-text/recognize-file.js</a>, <a href="speech-to-text_recognize-file.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="RecognizeStream.html">RecognizeStream</a></span>
|
<span class="param-type"><a href="FormatStream.html">FormatStream</a></span>
|
<span class="param-type"><a href="TimingStream.html">TimingStream</a></span>
</dd>
</dl>
<h4 class="name" id="module:watson-speech/speech-to-text/recognize-microphone"><span class="type-signature"></span>module:watson-speech/speech-to-text/recognize-microphone<span class="signature">(options)</span><span class="type-signature"> → {<a href="RecognizeStream.html">RecognizeStream</a>|<a href="FormatStream.html">FormatStream</a>}</span></h4>
<div class="description">
<p>Create and return a RecognizeStream sourcing audio from the user's microphone</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Also passed to {RecognizeStream}, and {FormatStream} when applicable</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>token</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Auth Token - see https://github.com/watson-developer-cloud/node-sdk#authorization</p></td>
</tr>
<tr>
<td class="name"><code>format</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>pipe the text through a {FormatStream} which performs light formatting. Also controls smart_formatting option unless explicitly set.</p></td>
</tr>
<tr>
<td class="name"><code>keepMicrophone</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>keeps an internal reference to the microphone stream to reuse in subsequent calls (prevents multiple permissions dialogs in firefox)</p></td>
</tr>
<tr>
<td class="name"><code>outputElement</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">DOMElement</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>pipe the text to a WriteableElementStream targeting the specified element. Also defaults objectMode to true to enable interim results.</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_recognize-microphone.js.html">speech-to-text/recognize-microphone.js</a>, <a href="speech-to-text_recognize-microphone.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="RecognizeStream.html">RecognizeStream</a></span>
|
<span class="param-type"><a href="FormatStream.html">FormatStream</a></span>
</dd>
</dl>
<h4 class="name" id="module:watson-speech/text-to-speech/get-voices"><span class="type-signature"></span>module:watson-speech/text-to-speech/get-voices<span class="signature">(options)</span><span class="type-signature"> → {Promise.<T>}</span></h4>
<div class="description">
<p>Returns a promise that resolves to an array of objects representing the available voices. Example:</p>
<pre class="prettyprint source lang-js"><code> [{
"name": "en-US_MichaelVoice",
"language": "en-US",
"customizable": true,
"gender": "male",
"url": "https://stream.watsonplatform.net/text-to-speech/api/v1/voices/en-US_MichaelVoice",
"description": "Michael: American English male voice."
},
//...
]</code></pre><p> Requires fetch, pollyfill available at https://github.com/github/fetch</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>token</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>auth token</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="text-to-speech_get-voices.js.html">text-to-speech/get-voices.js</a>, <a href="text-to-speech_get-voices.js.html#line44">line 44</a>
</li></ul></dd>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul>
<li>define format in @returns statement</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<T></span>
</dd>
</dl>
<h4 class="name" id="module:watson-speech/text-to-speech/synthesize"><span class="type-signature"></span>module:watson-speech/text-to-speech/synthesize<span class="signature">(options)</span><span class="type-signature"> → {Audio}</span></h4>
<div class="description">
<p>Synthesize and play the supplied text over the computers speakers.</p>
<p>Creates and returns a HTML5 <code><audio></code> element</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<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>token</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>auth token</p></td>
</tr>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>text to speak</p></td>
</tr>
<tr>
<td class="name"><code>voice</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
en-US_MichaelVoice
</td>
<td class="description last"><p>what voice to use - call getVoices() for a complete list.</p></td>
</tr>
<tr>
<td class="name"><code>X-WDC-PL-OPT-OUT</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>set to 1 to opt-out of allowing Watson to use this request to improve it's services</p></td>
</tr>
<tr>
<td class="name"><code>autoPlay</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>automatically play the audio</p></td>
</tr>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">DOMAudioElement</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p><audio> element - will be used instead of creating a new one if provided</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="text-to-speech_synthesize.js.html">text-to-speech/synthesize.js</a>, <a href="text-to-speech_synthesize.js.html#line41">line 41</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="module-watson-speech_text-to-speech_get-voices.html">module:watson-speech/text-to-speech/get-voices</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Audio</span>
</dd>
</dl>
<h4 class="name" id="noTimestamps"><span class="type-signature"></span>noTimestamps<span class="signature">(result)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Returns true if the result is missing it's timestamps</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>result</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></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_timing-stream.js.html">speech-to-text/timing-stream.js</a>, <a href="speech-to-text_timing-stream.js.html#line210">line 210</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="playFile"><span class="type-signature"></span>playFile<span class="signature">(file)</span><span class="type-signature"> → {Promise.<<a href="FilePlayer.html">FilePlayer</a>>}</span></h4>
<div class="description">
<p>Determines the file's content-type and then resolves to a FilePlayer instance</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>file</code></td>
<td class="type">
<span class="param-type">File</span>
|
<span class="param-type">Blob</span>
</td>
<td class="description last"></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_file-player.js.html">speech-to-text/file-player.js</a>, <a href="speech-to-text_file-player.js.html#line61">line 61</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="FilePlayer.html">FilePlayer</a>></span>
</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="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:receive-json">receive-json</a></li><li><a href="RecognizeStream.html#event:results">results</a></li><li><a href="RecognizeStream.html#event:send-json">send-json</a></li></ul><h3>Global</h3><ul><li><a href="global.html#getContentTypeFromFile">getContentTypeFromFile</a></li><li><a href="global.html#noTimestamps">noTimestamps</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.0</a> on Wed Jul 20 2016 21:29:03 GMT+0000 (UTC)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>