AudioSignalProblemOccurredEventArgs Class

Definition

Namespace:

System.Speech.Recognition

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

Source:

AudioSignalProblemOccurredEventArgs.cs

Provides data for the AudioSignalProblemOccurred event of a SpeechRecognizer or a SpeechRecognitionEngine.

public ref class AudioSignalProblemOccurredEventArgs : EventArgs

public class AudioSignalProblemOccurredEventArgs : EventArgs

type AudioSignalProblemOccurredEventArgs = class
    inherit EventArgs

Public Class AudioSignalProblemOccurredEventArgs
Inherits EventArgs

Inheritance

Object

EventArgs

AudioSignalProblemOccurredEventArgs

Examples

The following example defines an event handler that gathers information about an AudioSignalProblemOccurred event.

private SpeechRecognitionEngine sre;  

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

  // Add a handler for the AudioSignalProblemOccurred event.  
  sre.AudioSignalProblemOccurred += new EventHandler<AudioSignalProblemOccurredEventArgs>(sre_AudioSignalProblemOccurred);  
}  

// Gather information when the AudioSignalProblemOccurred event is raised.  
void sre_AudioSignalProblemOccurred(object sender, AudioSignalProblemOccurredEventArgs e)  
{  
  StringBuilder details = new StringBuilder();  

  details.AppendLine("Audio signal problem information:");  
  details.AppendFormat(  
    " Audio level:               {0}" + Environment.NewLine +  
    " Audio position:            {1}" + Environment.NewLine +  
    " Audio signal problem:      {2}" + Environment.NewLine +  
    " Recognition engine audio position: {3}" + Environment.NewLine,  
    e.AudioLevel, e.AudioPosition,  e.AudioSignalProblem,  
    e.RecognizerAudioPosition);  

  // Insert additional event handler code here.  
}  

Remarks

An instance of AudioSignalProblemOccurredEventArgs is created when the SpeechRecognitionEngine or SpeechRecognizer object raises an AudioSignalProblemOccurred event. To obtain information related to an AudioSignalProblemOccurred event, access the following properties in the handler for the event:

• AudioLevel

• AudioPosition

• AudioSignalProblem

• RecognizerAudioPosition

The AudioPosition property references the input device's position in its generated audio stream. By contrast, the RecognizerAudioPosition property references the recognizer's position within its audio input. These positions can be different. For more information, see Using Speech Recognition Events.

The AudioSignalProblem property indicates which problem occurred.

AudioSignalProblemOccurredEventArgs derives from EventArgs.

Properties

AudioLevel	Gets the audio level associated with the event.
AudioPosition	Gets the position in the input device's audio stream that indicates where the problem occurred.
AudioSignalProblem	Gets the audio signal problem.
RecognizerAudioPosition	Gets the position in the audio input that the recognizer has received that indicates where the problem occurred.

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)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• AudioSignalProblem
• AudioSignalProblemOccurred
• AudioSignalProblemOccurred