Version: 2017.4
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.


class in UnityEngine.Windows.Speech


Inherits from:Windows.Speech.PhraseRecognizer

Suggest a change


Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.


Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.




The GrammarRecognizer is a complement to the KeywordRecognizer. In many cases developers will find the KeywordRecognizer fills all their development needs. However, in some cases, more complex grammars will be better expressed in the form of an xml file on disk. The GrammarRecognizer uses Extensible Markup Language (XML) elements and attributes, as specified in the World Wide Web Consortium (W3C) Speech Recognition Grammar Specification (SRGS) Version 1.0. These XML elements and attributes represent the rule structures that define the words or phrases (commands) recognized by speech recognition engines.

Information on this format can be found here http://www.w3.orgspeech-grammarspeech-grammar/ or on MSDN.

There can be many grammar recognizers active at any given point in time, but no two grammar recognizers may use the same grammar file.

Grammar recognizer is currently functional only on Windows 10.


GrammarFilePathReturns the grammar file path which was supplied when the grammar recognizer was created.


GrammarRecognizerCreates a grammar recognizer using specified file path and minimum confidence.

Inherited Members


IsRunningTells whether the phrase recognizer is listening for phrases.

Public Methods

DisposeDisposes the resources used by phrase recognizer.
StartMakes the phrase recognizer start listening to phrases.
StopStops the phrase recognizer from listening to phrases.


OnPhraseRecognizedEvent that gets fired when the phrase recognizer recognizes a phrase.


PhraseRecognizedDelegateDelegate for OnPhraseRecognized event.