This documentation is archived and is not being maintained.

AudioLevelUpdatedEventArgs Class

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 : EventArgs

The AudioLevelUpdatedEventArgs type exposes the following members.

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

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns 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

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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