RecognizerInfo Class

 
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.

Represents information about a SpeechRecognizer or SpeechRecognitionEngine instance.

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

System.Object
  System.Speech.Recognition.RecognizerInfo

Public Class RecognizerInfo
	Implements IDisposable

NameDescription
System_CAPS_pubpropertyAdditionalInfo

Gets additional information about a SpeechRecognizer or SpeechRecognitionEngine instance.

System_CAPS_pubpropertyCulture

Gets the culture supported by a SpeechRecognizer or SpeechRecognitionEngine instance.

System_CAPS_pubpropertyDescription

Gets the description of a SpeechRecognizer or SpeechRecognitionEngine instance.

System_CAPS_pubpropertyId

Gets the identifier of a SpeechRecognizer or SpeechRecognitionEngine instance.

System_CAPS_pubpropertyName

Gets the friendly name of a SpeechRecognizer or SpeechRecognitionEngine instance.

System_CAPS_pubpropertySupportedAudioFormats

Gets the audio formats supported by a SpeechRecognizer or SpeechRecognitionEngine instance.

NameDescription
System_CAPS_pubmethodDispose()

Disposes the RecognizerInfo object.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

You can obtain identifying information for an initialized recognition engine using SpeechRecognizer.RecognizerInfo for a SpeechRecognizer object or SpeechRecognitionEngine.RecognizerInfo for a SpeechRecognitionEngine object.

The information returned in instances of RecognizerInfo obtained from a SpeechRecognizer is determined by the settings in the Speech Properties member of the Control Panel.

You can use instances of RecognizerInfo to construct a specific configuration of SpeechRecognitionEngine using the SpeechRecognitionEngine(RecognizerInfo) constructor.

The static method InstalledRecognizers returns a list of all available SpeechRecognitionEngine configurations as RecognizerInfo instances.

The following example validates a given CultureInfo and identifier string against the permitted SpeechRecognitionEngine configurations, expressed as a list of RecognizerInfo objects.

If the CultureInfo and identifier string are valid, the example creates a new instance of SpeechRecognitionEngine using the RecognizerInfo instance as an argument.


private SpeechRecognitionEngine SelectRecognizer(CultureInfo requiredCulture, string requiredId) 
{
  // Select based on a specific recognizer configuration
  SpeechRecognitionEngine speechRecognitionEngine=null;
  foreach (RecognizerInfo config in SpeechRecognitionEngine.InstalledRecognizers()) 
  {
    if (config.Culture.Equals(requiredCulture) && config.Id== requiredId) 
    {
      speechRecognitionEngine = new SpeechRecognitionEngine(config);
      break;
    }
  }
  return speechRecognitionEngine;
}

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: