EmulateRecognizeCompletedEventArgs Class

Definition

Namespace:

System.Speech.Recognition

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0

Source:

EmulateRecognizeCompletedEventArgs.cs

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

public ref class EmulateRecognizeCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs

public class EmulateRecognizeCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs

type EmulateRecognizeCompletedEventArgs = class
    inherit AsyncCompletedEventArgs

Public Class EmulateRecognizeCompletedEventArgs
Inherits AsyncCompletedEventArgs

Inheritance

Object

EventArgs

AsyncCompletedEventArgs

EmulateRecognizeCompletedEventArgs

Examples

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

Remarks

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.

Properties

Cancelled	Gets a value indicating whether an asynchronous operation has been canceled. (Inherited from AsyncCompletedEventArgs)
Error	Gets a value indicating which error occurred during an asynchronous operation. (Inherited from AsyncCompletedEventArgs)
Result	Gets the results of emulated recognition.
UserState	Gets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (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)
RaiseExceptionIfNecessary()	Raises a user-supplied exception if an asynchronous operation failed. (Inherited from AsyncCompletedEventArgs)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• Result
• EmulateRecognizeCompleted
• EmulateRecognizeCompleted