watson-speech
Version:
IBM Watson Speech to Text and Text to Speech SDK for web browsers.
128 lines (106 loc) • 5.27 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: speech-to-text/index.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/index.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>'use strict';
/**
* IBM Watson Speech to Text JavaScript SDK
*
* The primary methods for interacting with the Speech to Text JS SDK are:
* * `recognizeMicrophone()` for live microphone input
* * `recognizeFile()` for file `<input>`'s and other data sources (e.g. a Blob loaded via AJAX)
*
* However, the underlying streams and utils that they use are also exposed for advanced usage.
*
* @module watson-speech/speech-to-text
*/
module.exports = {
// "easy-mode" API
/**
* @see module:watson-speech/speech-to-text/recognize-microphone
*/
recognizeMicrophone: require('./recognize-microphone'),
/**
* @see module:watson-speech/speech-to-text/recognize-blob
*/
recognizeFile: require('./recognize-file'),
/**
* @see module:watson-speech/speech-to-text/get-models
*/
getModels: require('./get-models'),
// individual components to build more customized solutions
/**
* @see WebAudioL16Stream
*/
WebAudioL16Stream: require('./webaudio-l16-stream'),
/**
* @see RecognizeStream
*/
RecognizeStream: require('./recognize-stream'),
/**
* @see FilePlayer
*/
FilePlayer: require('./file-player'),
/**
* @see FormatStream
*/
FormatStream: require('./format-stream'),
/**
* @see TimingStream
*/
TimingStream: require('./timing-stream'),
/**
* @see ResultStream
*/
ResultStream: require('./result-stream'),
/**
* @see SpeakerStream
*/
SpeakerStream: require('./speaker-stream'),
/**
* @see WritableElementStream
*/
WritableElementStream: require('./writable-element-stream'),
// external components exposed for convenience
/**
* @see https://www.npmjs.com/package/get-user-media-promise
*/
getUserMedia: require('get-user-media-promise'),
/**
* @see https://www.npmjs.com/package/microphone-stream
*/
MicrophoneStream: require('microphone-stream'),
/**
* @see https://nodejs.org/api/buffer.html
*/
Buffer: Buffer
};
</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="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>