v0.31 docs

Author: nfriedly

CHANGELOG.md

@@ -1,7 +1,8 @@
 # Changelog
 
-### v0.30.2
-* Fixed error message when source ends before websocket connection is opened.
+### v0.31.0
+* Added support for a mediaStream argument to recognizeMicrophone() for advanced usages
+* Fixed error message when source ends before WebSocket connection is opened.
 
 ### v0.30.1
 * added recognizeMicrophone.isSupported flag (checks for getUserMedia, assumes other features will be there if that one is)

README.md

@@ -74,6 +74,7 @@ The core of the library is the [RecognizeStream] that performs the actual transc
 
 Options: 
 * `keepMic`: if true, preserves the MicrophoneStream for subsequent calls, preventing additional permissions requests in Firefox
+* `mediaStream`: Optionally pass in an existing media stream rather than prompting the user for microphone access.
 * Other options passed to [RecognizeStream]
 * Other options passed to [SpeakerStream] if `options.resultsbySpeaker` is set to true
 * Other options passed to [FormatStream] if `options.format` is not set to false

speech-to-text/recognize-microphone.js

@@ -50,6 +50,7 @@ var bitBucket = new Writable({
  * @param {String|DOMElement} [options.outputElement] pipe the text to a [WriteableElementStream](WritableElementStream.html) targeting the specified element. Also defaults objectMode to true to enable interim results.
  * @param {Boolean} [options.extractResults=false] pipe results through a ResultStream stream to simplify the objects. (Default behavior before v0.22) Requires objectMode.
  * @param {Boolean} [options.resultsBySpeaker=false] Pipe results through a SpeakerStream. Forces speaker_labels and objectMode to be true.
+ * @param {MediaStream} [options.mediaStream] Optionally pass in an existing MediaStream
  *
  * @returns {RecognizeStream|SpeakerStream|FormatStream|ResultStream}
  */