Skip to content

Commit d10a7fa

Browse files
authored
Correct JSDoc for resultsBySpeaker
speaker_labels (with narrowband models) does in fact support broadband input
1 parent 68aebf2 commit d10a7fa

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

speech-to-text/recognize-microphone.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ var bitBucket = new Writable({
4848
* @param {Boolean} [options.format=true] - pipe the text through a FormatStream which performs light formatting. Also controls smart_formatting option unless explicitly set.
4949
* @param {Boolean} [options.keepMicrophone=false] - keeps an internal reference to the microphone stream to reuse in subsequent calls (prevents multiple permissions dialogs in firefox)
5050
* @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.
51-
* @param {Boolean} [options.extractResults=false] pipe results through a ResultExtractor stream to simplify the objects. (Default behavior before v0.22) Requires objectMode.
52-
* @param {Boolean} [options.resultsBySpeaker=false] Not currently functional because microphone input provides broadband audio, but during the current beta release, speaker recognition only works on narrowband models.
51+
* @param {Boolean} [options.extractResults=false] pipe results through a ResultStream stream to simplify the objects. (Default behavior before v0.22) Requires objectMode.
52+
* @param {Boolean} [options.resultsBySpeaker=false] Pipe results through a SpeakerStream. Forces speaker_labels and objectMode to be true.
5353
*
5454
* @returns {RecognizeStream|SpeakerStream|FormatStream|ResultStream}
5555
*/

0 commit comments

Comments
 (0)