DictationGrammar.SetDictationContext(String, String) Method

Definition

Namespace:

System.Speech.Recognition

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

Source:

DictationGrammar.cs

Adds a context to a dictation grammar that has been loaded by a SpeechRecognizer or a SpeechRecognitionEngine object.

public:
 void SetDictationContext(System::String ^ precedingText, System::String ^ subsequentText);

public void SetDictationContext (string precedingText, string subsequentText);

member this.SetDictationContext : string * string -> unit

Public Sub SetDictationContext (precedingText As String, subsequentText As String)

Parameters

precedingText

String

Text that indicates the start of a dictation context.

subsequentText

String

Text that indicates the end of a dictation context.

Remarks

By default, the dictation grammar does not make use of specific words or word order to identify and interpret audio input. When a context is added to a dictation grammar, the recognition engine uses the precedingText and subsequentText to identify when to interpret speech as dictation.

Note

A dictation grammar must be loaded by a SpeechRecognizer or SpeechRecognitionEngine object before you can use SetDictationContext to add a context.

The following table describes how the recognition engine uses the two parameters to determine when to use the dictation grammar.

precedingText	subsequentText	Description
not null	not null	The recognition engine uses the terms to bracket possible candidate phrases.
null	not null	The recognition engine uses the subsequentText to finish dictation.
not null	null	The recognition engine uses the precedingText to start dictation.
null	null	The recognition engine does not use a context when using the dictation grammar.

See also

• Grammar