watson-speech

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Module: watson-speech/speech-to-text/recognize-file</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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/recognize-file</h1> <section> <header> </header> <article> <div class="container-overview"> <h4 class="name" id="module:watson-speech/speech-to-text/recognize-file"><span class="type-signature"></span>(require("watson-speech/speech-to-text/recognize-file"))<span class="signature">(options)</span><span class="type-signature"> → {<a href="RecognizeStream.html">RecognizeStream</a>|<a href="SpeakerStream.html">SpeakerStream</a>|<a href="FormatStream.html">FormatStream</a>|<a href="ResultStream.html">ResultStream</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 dragdrop target, 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>file</code></td> <td class="type"> <span class="param-type">Blob</span> | <span class="param-type">FileString</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>String url or the raw audio data as a Blob or File instance to be transcribed (and optionally played). Playback may not with with Blob or File on mobile Safari.</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> <tr> <td class="name"><code>extractResults</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>pipe results through a ResultExtractor stream to simplify the objects. (Default behavior before v0.22) Automatically enables objectMode.</p></td> </tr> <tr> <td class="name"><code>resultsBySpeaker</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>pipe results through a SpeakerStream. Causes each data event to include multiple results, each with a speaker field. Automatically enables objectMode and speaker_labels. Adds some delay to processing.</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#line49">line 49</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="SpeakerStream.html">SpeakerStream</a></span> | <span class="param-type"><a href="FormatStream.html">FormatStream</a></span> | <span class="param-type"><a href="ResultStream.html">ResultStream</a></span> | <span class="param-type"><a href="TimingStream.html">TimingStream</a></span> </dd> </dl> </div> </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>