RecognizerInfo Class

.NET Framework (current version)

Other Versions

Represents information about a SpeechRecognizer or SpeechRecognitionEngine instance.

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

Inheritance Hierarchy

System::Object
System.Speech.Recognition::RecognizerInfo

Syntax

C++

public ref class RecognizerInfo : IDisposable

Properties

	Name	Description
	AdditionalInfo	Gets additional information about a SpeechRecognizer or SpeechRecognitionEngine instance.
	Culture	Gets the culture supported by a SpeechRecognizer or SpeechRecognitionEngine instance.
	Description	Gets the description of a SpeechRecognizer or SpeechRecognitionEngine instance.
	Id	Gets the identifier of a SpeechRecognizer or SpeechRecognitionEngine instance.
	Name	Gets the friendly name of a SpeechRecognizer or SpeechRecognitionEngine instance.
	SupportedAudioFormats	Gets the audio formats supported by a SpeechRecognizer or SpeechRecognitionEngine instance.

Methods

	Name	Description
	Dispose()	Disposes the RecognizerInfo object.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

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.

Examples

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;
}

Version Information

.NET Framework
Available since 3.0

Thread Safety

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