adding autoPlay option to .synthesize(), filtering querystring params

Author: nfriedly

README.md

@@ -40,7 +40,7 @@ where the max length is around 1000 characters after the token is accounted for.
 Options: 
 * text - the text to transcribe // todo: list supported languages
 * voice - the desired playback voice's name - see .getVoices(). Note that the voices are language-specific.
-* todo: autoPlay option that can be set to false to preload audio
+* autoPlay - set to false to prevent the audio from automatically playing
 
 ### `.getVoices()` -> Promise
 
@@ -155,6 +155,10 @@ Accepts input from `RecognizeStream()` and friends, writes text to supplied `out
 
 ## Changelog
 
+### v0.12
+* Added `autoPlay` option to `synthesize()`
+* Added proper parameter filtering to `synthesize()`
+
 ### v0.11
 * renamed `recognizeBlob` to `recognizeFile` to make the primary usage more apparent
 * Added support for `<input>` and `<textarea>` elements when using the `targetElement` option (or a `WritableElementStream`)
@@ -201,3 +205,4 @@ Accepts input from `RecognizeStream()` and friends, writes text to supplied `out
 * consider moving STT core to standalone module
 * look for bug where single-word final results may omit word confidence (possibly due to FormatStream?)
 * fix bug where TimingStream shows words slightly before they're spoken
+* automatically turn on objectMode when required by other options (timing, confidence, etc.

text-to-speech/synthesize.js

@@ -14,8 +14,11 @@
  * limitations under the License.
  */
 "use strict";
+var pick = require('object.pick');
 var qs = require('../util/querystring.js');
 
+var QUERY_PARAMS_ALLOWED = ['voice', 'X-WDC-PL-OPT-OUT', 'text', 'watson-token'];
+
 /**
  * @module watson-speech/text-to-speech/synthesize
  */
@@ -30,6 +33,7 @@ var qs = require('../util/querystring.js');
  * @param {String} options.text text to speak
  * @param {String} [options.voice=en-US_MichaelVoice] what voice to use - call getVoices() for a complete list.
  * @param {Number} [options.X-WDC-PL-OPT-OUT=0] set to 1 to opt-out of allowing Watson to use this request to improve it's services
+ * @param {Boolean} [options.autoPlay=true] automatically play the audio
  * @returns {Audio}
  * @see module:watson-speech/text-to-speech/get-voices
  */
@@ -41,8 +45,10 @@ module.exports = function synthesize(options) {
   delete options.token;
   var audio = new Audio();
   audio.crossOrigin = true;
-  audio.src = 'https://stream.watsonplatform.net/text-to-speech/api/v1/synthesize?' + qs.stringify(options);
-  audio.play();
+  audio.src = 'https://stream.watsonplatform.net/text-to-speech/api/v1/synthesize?' + qs.stringify(pick(options, QUERY_PARAMS_ALLOWED));
+  if (options.autoPlay !== false) {
+    audio.play();
+  }
   return audio;
 };