SpeechRecognition: interimResults property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The interimResults property of the SpeechRecognition interface controls whether interim results should be returned (true) or not (false). Interim results are results that are not yet final (e.g. the SpeechRecognitionResult.isFinal property is false).

The default value for interimResults is false.

Value

A boolean value representing the state of the current SpeechRecognition's interim results. true means interim results are returned, and false means they aren't.

Examples

This code is excerpted from our Speech color changer example.

js
const grammar =
  "#JSGF V1.0; grammar colors; public <color> = aqua | azure | beige | bisque | black | blue | brown | chocolate | coral | crimson | cyan | fuchsia | ghostwhite | gold | goldenrod | gray | green | indigo | ivory | khaki | lavender | lime | linen | magenta | maroon | moccasin | navy | olive | orange | orchid | peru | pink | plum | purple | red | salmon | sienna | silver | snow | tan | teal | thistle | tomato | turquoise | violet | white | yellow ;";
const recognition = new SpeechRecognition();
const speechRecognitionList = new SpeechGrammarList();
speechRecognitionList.addFromString(grammar, 1);
recognition.grammars = speechRecognitionList;
//recognition.continuous = false;
recognition.lang = "en-US";
recognition.interimResults = false;
recognition.maxAlternatives = 1;

// ...

Specifications

Specification
Web Speech API
# dom-speechrecognition-interimresults

Browser compatibility

BCD tables only load in the browser

See also