Name Property

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Gets the friendly name of a SpeechRecognitionEngine instance.

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

Syntax

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

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

Property Value

Type: System..::..String

Returns the friendly name for a specific SpeechRecognitionEngine instance.

Examples

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

 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