SpeechRecognitionEvent.resultIndex

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The resultIndex read-only property of the SpeechRecognitionEvent interface returns the lowest index value result in the SpeechRecognitionResultList "array" that has actually changed.

The SpeechRecognitionResultList object is not an array, but it has a getter that allows it to be accessed by array syntax.

Syntax

var myResultIndex = event.resultIndex;

Value

A number.

Examples

recognition.onresult = function(event) {
  var color = event.results[0][0].transcript;
  diagnostic.textContent = 'Result received: ' + color + '.';
  bg.style.backgroundColor = color;
  console.log(event.resultIndex); // returns 0 if there is only one result
}

Specifications

Specification
Web Speech API
# dom-speechrecognitionevent-resultindex

Browser compatibility

BCD tables only load in the browser

Firefox OS permissions

To use speech recognition in an app, you need to specify the following permissions in your manifest:

"permissions": {
  "audio-capture" : {
    "description" : "Audio capture"
  },
  "speech-recognition" : {
    "description" : "Speech recognition"
  }
}

You also need a privileged app, so you need to include this as well:

  "type": "privileged"

See also