watson-speech
Version:
IBM Watson Speech to Text and Text to Speech SDK for web browsers.
155 lines (120 loc) • 7.25 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: speech-to-text/recognize-file.js</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">Source: speech-to-text/recognize-file.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* Copyright 2015 IBM Corp. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
var BlobStream = require('readable-blob-stream');
var RecognizeStream = require('./recognize-stream.js');
var FilePlayer = require('./file-player.js');
var FormatStream = require('./format-stream.js');
var TimingStream = require('./timing-stream.js');
var assign = require('object.assign/polyfill')();
var WritableElementStream = require('./writable-element-stream');
/**
* @module watson-speech/speech-to-text/recognize-file
*/
/**
* Create and return a RecognizeStream from a File or Blob
* (e.g. from a file <input>, a dtagdrop targe, or an ajax request)
*
* @param {Object} options - Also passed to {MediaElementAudioStream} and to {RecognizeStream}
* @param {String} options.token - Auth Token - see https://github.com/watson-developer-cloud/node-sdk#authorization
* @param {Blob|File} options.data - the raw audio data as a Blob or File instance
* @param {Boolean} [options.play=false] - If a file is set, play it locally as it's being uploaded
* @param {Boolena} [options.format=true] - pipe the text through a {FormatStream} which performs light formatting. Also controls smart_formatting option unless explicitly set.
* @param {Boolena} [options.realtime=options.play] - pipe the text through a {TimingStream} which slows the output down to real-time to match the audio playback.
* @param {String|DOMElement} [options.outputElement] pipe the text to a WriteableElementStream targeting the specified element. Also defaults objectMode to true to enable interim results.
*
* @returns {RecognizeStream|FormatStream|TimingStream}
*/
module.exports = function recognizeFile(options) { // eslint-disable-line complexity
if (!options || !options.token) {
throw new Error('WatsonSpeechToText: missing required parameter: opts.token');
}
// the WritableElementStream works best in objectMode
if (options.outputElement && options.objectMode !== false) {
options.objectMode = true;
}
// default format to true (capitals and periods)
// default smart_formatting to options.format value (dates, currency, etc.)
options.format = (options.format !== false);
if (typeof options.smart_formatting === 'undefined') {
options.smart_formatting = options.format;
}
var realtime = options.realtime || typeof options.realtime === 'undefined' && options.play;
// the timing stream requires timestamps to work, so enable them automatically
if (realtime) {
options.timestamps = true;
}
// we don't want the readable stream to have objectMode on the input even if we're setting it for the output
// unless were in realtime mode - in which case the timing stream requires objectMode input.
var rsOpts = assign({}, options);
rsOpts.readableObjectMode = options.objectMode || realtime;
delete rsOpts.objectMode;
var recognizeStream = new RecognizeStream(rsOpts);
var stream = new BlobStream(options.data).pipe(recognizeStream);
if (options.format) {
stream = stream.pipe(new FormatStream(options));
}
if (realtime) {
stream = stream.pipe(new TimingStream(options));
stream.on('stop', recognizeStream.stop.bind(recognizeStream));
} else {
stream.stop = recognizeStream.stop.bind(recognizeStream);
}
if (options.play) {
FilePlayer.playFile(options.data).then(function(player) {
recognizeStream.on('stop', player.stop.bind(player));
}).catch(function(err) {
stream.emit('playback-error', err);
});
}
if (options.outputElement) {
stream.pipe(new WritableElementStream(options));
}
return stream;
};
</code></pre>
</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>