Id Property

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Gets the identifier of a SpeechRecognitionEngine instance.

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

Syntax

Visual Basic (Declaration)
Public ReadOnly Property Id As String
	Get
Visual Basic (Usage)
Dim instance As RecognizerInfo
Dim value As String

value = instance.Id
C#
public string Id { get; }

Property Value

Type: System..::..String

Returns the identifier for a specific SpeechRecognitionEngine instance.

Remarks

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

Examples

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.

C# Copy imageCopy Code
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));
}

See Also