Web/API/SpeechGrammarList

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

The SpeechGrammarList interface of the Web Speech API represents a list of SpeechGrammar objects containing words or patterns of words that we want the recognition service to recognize.

Grammar is defined using JSpeech Grammar Format (JSGF.) Other formats may also be supported in the future.

Constructor

SpeechGrammarList.SpeechGrammarList()

Creates a new SpeechGrammarList object.

Properties

SpeechGrammarList.length Read only

Returns the number of SpeechGrammar objects contained in the SpeechGrammarList.

Methods

SpeechGrammarList.item()

Standard getter — allows individual SpeechGrammar objects to be retrieved from the SpeechGrammarList using array syntax.

SpeechGrammarList.addFromURI()

Takes a grammar present at a specific URI and adds it to the SpeechGrammarList as a new SpeechGrammar object.

SpeechGrammarList.addFromString()

Takes a grammar present in a specific DOMString within the code base (e.g. stored in a variable) and adds it to the SpeechGrammarList as a new SpeechGrammar object.

Examples

In our simple Speech color changer example, we create a new SpeechRecognition object instance using the SpeechRecognition() constructor, create a new SpeechGrammarList, add our grammar string to it using the SpeechGrammarList.addFromString method, and set it to be the grammar that will be recognised by the SpeechRecognition instance using the SpeechRecognition.grammars property.

var 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 ;'
var recognition = new SpeechRecognition();
var speechRecognitionList = new SpeechGrammarList();
speechRecognitionList.addFromString(grammar, 1);
recognition.grammars = speechRecognitionList;

Specifications

Specification	Status	Comment
Web Speech APIThe definition of 'SpeechGrammarList()' in that specification.	Draft

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
SpeechGrammarList Experimental'	Chrome Full support 33 Prefixed' Notes' Full support 33 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Edge Full support ≤79 Prefixed' Notes' Full support ≤79 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Chrome Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.
SpeechGrammarList() constructor Experimental'	Chrome Full support 33 Prefixed' Notes' Full support 33 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Edge Full support ≤79 Prefixed' Notes' Full support ≤79 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Chrome Android Full support Yes Notes' Full support Yes Notes' Notes' You'll need to serve your code through a web server for recognition to work.	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support Yes Notes' Full support Yes Notes' Notes' You'll need to serve your code through a web server for recognition to work.
addFromString Experimental'	Chrome Full support 33 Prefixed' Notes' Full support 33 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Edge Full support ≤79 Prefixed' Notes' Full support ≤79 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Chrome Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.
addFromURI Experimental'	Chrome Full support 33 Prefixed' Notes' Full support 33 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Edge Full support ≤79 Prefixed' Notes' Full support ≤79 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Chrome Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.
item Experimental'	Chrome Full support 33 Prefixed' Full support 33 Prefixed' Prefixed' Implemented with the vendor prefix: webkit	Edge Full support ≤79 Prefixed' Full support ≤79 Prefixed' Prefixed' Implemented with the vendor prefix: webkit	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Chrome Android Full support Yes Prefixed' Full support Yes Prefixed' Prefixed' Implemented with the vendor prefix: webkit	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support Yes Prefixed' Full support Yes Prefixed' Prefixed' Implemented with the vendor prefix: webkit
length Experimental'	Chrome Full support 33 Prefixed' Notes' Full support 33 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Edge Full support ≤79 Prefixed' Notes' Full support ≤79 Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Chrome Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support Yes Prefixed' Notes' Full support Yes Prefixed' Notes' Prefixed' Implemented with the vendor prefix: webkit Notes' You'll need to serve your code through a web server for recognition to work.

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

See implementation notes.'

See implementation notes.

Requires a vendor prefix or different name for use.'

Requires a vendor prefix or different name for use.

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

• Web Speech API

SpeechGrammarList by Mozilla Contributors is licensed under CC-BY-SA 2.5.