SpeechRecognitionEngine::AudioFormat Property

.NET Framework (current version)

Gets the format of the audio being received by the SpeechRecognitionEngine.

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

Syntax

public:
property SpeechAudioFormatInfo^ AudioFormat {
	SpeechAudioFormatInfo^ get();
}

Property Value

Type: System.Speech.AudioFormat::SpeechAudioFormatInfo^

The format of audio at the input to the SpeechRecognitionEngine instance, or null if the input is not configured or set to the null input.

Remarks

To configure the audio input, use one of the following methods:

Examples

The example below uses AudioFormat to obtain and display audio format data.

static void DisplayAudioDeviceFormat(Label label, SpeechRecognitionEngine recognitionEngine) 
{

  if (recognitionEngine != null && label != null) 
  {
    label.Text = String.Format("Encoding Format:         {0}\n" +
          "AverageBytesPerSecond    {1}\n" +
          "BitsPerSample            {2}\n" +
          "BlockAlign               {3}\n" +
          "ChannelCount             {4}\n" +
          "SamplesPerSecond         {5}",
          recognitionEngine.AudioFormat.EncodingFormat.ToString(),
          recognitionEngine.AudioFormat.AverageBytesPerSecond,
          recognitionEngine.AudioFormat.BitsPerSample,
          recognitionEngine.AudioFormat.BlockAlign,
          recognitionEngine.AudioFormat.ChannelCount,
          recognitionEngine.AudioFormat.SamplesPerSecond);
    }
  }
}

Version Information

.NET Framework
Available since 3.0