basic text-to-speech support

Author: nfriedly

README.md

@@ -1,9 +1,9 @@
-IBM Watson Speech To Text Browser Client Library
-================================================
+IBM Watson Speech Services for Web Browsers
+===========================================
 
 [![Build Status](https://travis-ci.org/watson-developer-cloud/speech-javascript-sdk.svg?branch=master)](https://travis-ci.org/watson-developer-cloud/speech-javascript-sdk)
 
-Allows you to easily add voice recognition to any web app with minimal code. 
+Allows you to easily add voice recognition and synthesis to any web app with minimal code. 
 
 **Warning** This library is still early-stage and may see significant breaking changes.
 
@@ -21,13 +21,27 @@ See several examples at https://github.com/watson-developer-cloud/speech-javascr
 This library is built with [browserify](http://browserify.org/) and easy to use in browserify-based projects (`npm install --save watson-speech`), but you can also grab the compiled bundle from the 
 `dist/` folder and use it as a standalone library.
 
-## `WatsonSpeech.SpeechToText` Basic API
+Basic API
+---------
 
 Complete API docs should be published at http://watson-developer-cloud.github.io/speech-javascript-sdk/
 
 All API methods require an auth token that must be [generated server-side](https://github.com/watson-developer-cloud/node-sdk#authorization). 
 (Snp teee examples/token-server.js for a basic example.)
 
+## `Watson.TextToSpeech`
+
+### '.synthesize({text, token})`
+
+Speaks the supplied text through an automatically-created `<audio>` element. 
+Currently limited to text that can fit within a GET URL (this is particularly an issue on [Internet Explorer before Windows 10](http://stackoverflow.com/questions/32267442/url-length-limitation-of-microsoft-edge)
+where the max length is around 1000 characters after the token is accounted for.)
+
+Options: 
+* voice
+
+## `WatsonSpeech.SpeechToText` 
+
 
 ### `.recognizeMicrophone({token})` -> `RecognizeStream`
 

dist/watson-speech.js

@@ -1,7 +1,7 @@
 {
   "name": "watson-speech",
   "version": "0.8.3",
-  "description": "IBM Watson Speech to Text SDK for web browsers.",
+  "description": "IBM Watson Speech to Text and Text to Speech SDK for web browsers.",
   "main": "index.js",
   "scripts": {
     "watch-test": "karma start test/resources/karma.conf.js",

package.json

@@ -23,6 +23,7 @@ var pick = require('object.pick');
 var W3CWebSocket = require('websocket').w3cwebsocket;
 var contentType = require('./content-type');
 var defaults = require('defaults');
+var qs = require('../util/querystring.js');
 
 
 var OPENING_MESSAGE_PARAMS_ALLOWED = ['continuous', 'max_alternatives', 'timestamps', 'word_confidence', 'inactivity_timeout',
@@ -97,10 +98,7 @@ RecognizeStream.prototype.initialize = function () {
   }
 
   var queryParams = util._extend({model: 'en-US_BroadbandModel'}, pick(options, QUERY_PARAMS_ALLOWED));
-  var queryString = Object.keys(queryParams).map(function (key) {
-    return key + '=' + (key == 'watson-token' ? queryParams[key] : encodeURIComponent(queryParams[key])); // the server chokes if the token is correctly url-encoded
-  }).join('&');
-
+  var queryString = qs.stringify(queryParams);
   var url = (options.url || "wss://stream.watsonplatform.net/speech-to-text/api").replace(/^http/, 'ws') + '/v1/recognize?' + queryString;
 
   // turn off all the extras if we're just outputting text

speech-to-text/recognize-stream.js

@@ -1,5 +1,5 @@
 "use strict";
-var qs = require('querystring');
+var qs = require('../util/querystring.js');
 
 module.exports.synthesize = function(options) {
   if (!options || !options.token) {
@@ -9,7 +9,7 @@ module.exports.synthesize = function(options) {
   delete options.token;
   var audio = new Audio();
   audio.crossOrigin = true;
-  audio.src = 'https://stream.watsonplatform.net/text-to-speech/api/synthesize?' + qs.stringify(options);
+  audio.src = 'https://stream.watsonplatform.net/text-to-speech/api/v1/synthesize?' + qs.stringify(options);
   audio.play();
   return audio;
 };

text-to-speech/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+/**
+ * Stringify query params, Watson-style
+ *
+ * Why? The server that processes auth tokens currently only accepts the *exact* string, even if it's invalid for a URL.
+ * Properly url-encoding percent characters causes it to reject the token.
+ * So, this is a custom qs.stringify function that properly encodes everything except watson-token, passing it along verbatim
+ *
+ * @param {Object} queryParams
+ * @return {String}
+ */
+exports.stringify = function stringify(queryParams) {
+  return Object.keys(queryParams).map(function (key) {
+    return key + '=' + (key == 'watson-token' ? queryParams[key] : encodeURIComponent(queryParams[key])); // the server chokes if the token is correctly url-encoded
+  }).join('&');
+};