SpeechGrammarList: addFromString() method

Limited availability

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

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

The addFromString() method of the SpeechGrammarList interface takes a grammar present in a specific string within the code base (e.g. stored in a variable) and adds it to the SpeechGrammarList as a new SpeechGrammar object.

Syntax

js
addFromString(string)
addFromString(string, weight)

Parameters

string

A string representing the grammar to be added.

weight Optional

A float representing the weight of the grammar relative to other grammars present in the SpeechGrammarList. The weight means the importance of this grammar, or the likelihood that it will be recognized by the speech recognition service. The value can be between 0.0 and 1.0; If not specified, the default used is 1.0.

Return value

None (undefined).

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;

Specifications

Specification
Web Speech API
# dom-speechgrammarlist-addfromstring

Browser compatibility

BCD tables only load in the browser

See also