EmulateRecognizeCompletedEventArgs Class


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

Provides data for the EmulateRecognizeCompleted event of the SpeechRecognizer and SpeechRecognitionEngine classes.

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


public class EmulateRecognizeCompletedEventArgs : AsyncCompletedEventArgs


Gets a value indicating whether an asynchronous operation has been canceled.(Inherited from AsyncCompletedEventArgs.)


Gets a value indicating which error occurred during an asynchronous operation.(Inherited from AsyncCompletedEventArgs.)


Gets the results of emulated recognition.


Gets the unique identifier for the asynchronous task.(Inherited from AsyncCompletedEventArgs.)


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


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


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


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


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


Raises a user-supplied exception if an asynchronous operation failed.(Inherited from AsyncCompletedEventArgs.)


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

An instance of EmulateRecognizeCompletedEventArgs is created when the SpeechRecognitionEngine object raises the EmulateRecognizeCompleted event. To obtain information about the result of recognition, access the Result property in the handler for the event.

Emulation is the process by which text, instead of audio, is the input to a speech recognition engine. To bypass the audio inputs for a SpeechRecognitionEngine object during emulation, use the SetInputToNull method.

If the speech recognition engine encounters an exception during the recognition operation, the Error property is set to the exception and the Result property is set to null.

EmulateRecognizeCompletedEventArgs derives from AsyncCompletedEventArgs.

The following example adds an event handler for the EmulateRecognizeCompleted event to a SpeechRecognitionEngine. The handler gets the recognized text from the Result property.

private SpeechRecognitionEngine sre;

// Initialize the speech recognition engine. 
private void Initialize()
  sre = new SpeechRecognitionEngine();

  // Add a handler for the EmulateRecognizeCompleted event.
  sre.EmulateRecognizeCompleted += new EventHandler<EmulateRecognizeCompletedEventArgs>(sre_EmulateRecognizeCompleted);

  // Add other initialization code here.

// Handle the EmulateRecognizeCompleted event. 
void sre_EmulateRecognizeCompleted(object sender, EmulateRecognizeCompletedEventArgs e)
  if (e.Result == null) return;

  string phrase = e.Result.Text;

  // Add event handler code here.

.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