This is an experimental technology
Check 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 theSpeechGrammarList
.
Methods
SpeechGrammarList.item()
- Standard getter — allows individual
SpeechGrammar
objects to be retrieved from theSpeechGrammarList
using array syntax. SpeechGrammarList.addFromURI()
- Takes a grammar present at a specific URI and adds it to the
SpeechGrammarList
as a newSpeechGrammar
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 theSpeechGrammarList
as a newSpeechGrammar
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 API The definition of 'SpeechGrammarList()' in that specification. |
Draft |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
SpeechGrammarList | Chrome
Full support
33
| Edge
Full support
≤79
| Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android
Full support
Yes
|
SpeechGrammarList() constructor | Chrome
Full support
33
| Edge
Full support
≤79
| Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android
Full support
Yes
|
addFromString | Chrome
Full support
33
| Edge
Full support
≤79
| Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android
Full support
Yes
|
addFromURI | Chrome
Full support
33
| Edge
Full support
≤79
| Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android
Full support
Yes
|
item | Chrome
Full support
33
| Edge
Full support
≤79
| Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android
Full support
Yes
|
length | Chrome
Full support
33
| Edge
Full support
≤79
| Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android
Full support
Yes
| Chrome Android
Full support
Yes
| Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android
Full support
Yes
|
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.