Back to Content

SpeechGrammarList: addFromString() method

files/en-us/web/api/speechgrammarlist/addfromstring/index.md

latest1.0 KB
Original Source

{{APIRef("Web Speech API")}}{{deprecated_header}}

The addFromString() method of the {{domxref("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 {{domxref("SpeechGrammar")}} object.

Syntax

js-nolint
addFromString(string)
addFromString(string, weight)

Parameters

  • string
    • : A string representing the grammar to be added.
  • weight {{optional_inline}}
    • : A float representing the weight of the grammar relative to other grammars present in the {{domxref("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 ({{jsxref("undefined")}}).

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also