RecognizerInfo.Id Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the identifier of a SpeechRecognizer or SpeechRecognitionEngine instance.

Namespace:   System.Speech.Recognition
Assembly:  System.Speech (in System.Speech.dll)

public string Id { get; }

Property Value

Type: System.String

Returns the identifier for a specific SpeechRecognizer or SpeechRecognitionEngine instance.

The identifier returned by the Id property is the same as the token name of the recognition engine in the Windows registry.

The following example implements a button click that displays all the information in a RecognizerInfo instance. The example uses the Id property to obtain the identifier string of a recognition engine configuration, and then displays it in a MessageBox.

private void recognizerInfoButton_Click(object sender, EventArgs e) 
{
  RecognizerInfo info = _recognizer.RecognizerInfo;
  string AudioFormats = "";
  foreach (SpeechAudioFormatInfo fmt in info.SupportedAudioFormats) 
  {
    AudioFormats += String.Format("       {0}\n",  fmt.EncodingFormat.ToString());
  }
  string AdditionalInfo = "";
  foreach (string key in info.AdditionalInfo.Keys) 
  {
    AdditionalInfo += String.Format("      {0}: {1}\n", key, info.AdditionalInfo[key]);
  }
  MessageBox.Show(String.Format(
                           "Name:                 {0 }\n" +
                           "Description:          {1} \n" +
                           "SupportedAudioFormats:\n" +
                           "{2} " +
                           "Culture:              {3} \n" +
                           "AdditionalInfo:       \n" +
                           " {4}\n",
                           info.Name.ToString(),
                           info.Description.ToString(),
                           AudioFormats,
                           info.Culture.ToString(),
                           AdditionalInfo));
}

.NET Framework
Available since 3.0
Return to top
Show: