AudioLevelUpdatedEventArgs Class


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

Provides data for the AudioLevelUpdated event of the SpeechRecognizer or the SpeechRecognitionEngine class.

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


Public Class AudioLevelUpdatedEventArgs
	Inherits EventArgs


Gets the new level of audio input after the SpeechRecognitionEngine.AudioLevelUpdated or the SpeechRecognizer.AudioLevelUpdated event is raised.


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


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

When they are raised, the SpeechRecognitionEngine.AudioLevelUpdated and SpeechRecognizer.AudioLevelUpdated events pass an instance of AudioLevelUpdatedEventArgs to the handler for the associated event.

The AudioLevel property gets the new level of audio input when the SpeechRecognitionEngine.AudioLevelUpdated or SpeechRecognizer.AudioLevelUpdated event is raised.

The AudioLevel property of the SpeechRecognizer and SpeechRecognitionEngine classes provides the current level of the audio input to the speech recognition engine.

The following example adds an event handler to a SpeechRecognitionEngine object. The handler outputs the new audio level to the console.

AudioLevelUpdatedEventArgs derives from EventArgs.

private SpeechRecognitionEngine sre;

// Initialize the SpeechRecognitionEngine object. 
private void Initialize()
  sre = new SpeechRecognitionEngine();

  // Add an event handler for the AudioLevelUpdated event.
  sre.AudioLevelUpdated += new EventHandler<AudioLevelUpdatedEventArgs>(sre_AudioLevelUpdated);

  // Add other initialization code here.

// Write the audio level to the console when the AudioLevelUpdated event is raised.
void sre_AudioLevelUpdated(object sender, AudioLevelUpdatedEventArgs e)
  Console.WriteLine("The audio level is now: {0}.", e.AudioLevel);

.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