added message event to recognize stream for any data recieved over the wire

Author: nfriedly

speech-to-text/recognize-file.js

@@ -150,6 +150,12 @@ module.exports = function recognizeFile(options) { // eslint-disable-line comple
     }
   }
 
+  // expose the original stream to for debugging (and to support the JSON tab on the STT demo)
+  if (stream !== recognizeStream) {
+    stream.recognizeStream = recognizeStream;
+  }
+
+
   return stream;
 };
 

speech-to-text/recognize-microphone.js

@@ -178,11 +178,13 @@ module.exports = function recognizeMicrophone(options) {
     }
   });
 
-  // add a stop button to whatever the final stream ends up being
   if (stream !== recognizeStream) {
+    // add a stop button to whatever the final stream ends up being
     stream.stop = recognizeStream.stop.bind(recognizeStream);
-  }
 
+    // expose the original stream to for debugging (and to support the JSON tab on the STT demo)
+    stream.recognizeStream = recognizeStream;
+  }
 
   return stream;
 };

speech-to-text/recognize-stream.js

@@ -285,6 +285,14 @@ RecognizeStream.prototype.initialize = function() {
   }
 
   socket.onmessage = function(frame) {
+    /**
+     * Emit any messages received over the wire, mainly used for debugging.
+     *
+     * @event RecognizeStream#message
+     * @param {Object} message - frame object with a data attribute that's either a string or a Buffer/TypedArray
+     */
+    this.emit('message', frame);
+
     if (typeof frame.data !== 'string') {
       return emitError('Unexpected binary data received from server', frame);
     }
@@ -336,14 +344,20 @@ RecognizeStream.prototype.initialize = function() {
 
 RecognizeStream.prototype.sendJSON = function sendJSON(msg) {
   /**
+   * Emits any JSON object sent to the service from the client. Mainly used for debugging.
    * @event RecognizeStream#send-json
-   * @param {Object} msg - the raw JSON sent to Watson - sometimes useful for debugging
+   * @param {Object} msg
    */
   this.emit('send-json', msg);
   return this.socket.send(JSON.stringify(msg));
 };
 
 RecognizeStream.prototype.sendData = function sendData(data) {
+  /**
+   * Emits any Binary object sent to the service from the client. Mainly used for debugging.
+   * @event RecognizeStream#send-data
+   * @param {Object} msg
+   */
   this.emit('send-data', data);
   return this.socket.send(data);
 };