SpeechGrammar

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

The SpeechGrammar interface of the Web Speech API represents a set of 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

SpeechGrammar() Non-standard Experimental

Creates a new SpeechGrammar object.

Instance properties

SpeechGrammar.src Experimental

Sets and returns a string containing the grammar from within in the SpeechGrammar object instance.

SpeechGrammar.weight Optional Experimental

Sets and returns the weight of the SpeechGrammar object.

Examples

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;

console.log(speechRecognitionList[0].src); // should return the same as the contents of the grammar variable
console.log(speechRecognitionList[0].weight); // should return 1 - the same as the weight set in line 4.

Specifications

Specification
Web Speech API
# speechreco-speechgrammar

Browser compatibility

BCD tables only load in the browser

See also