SpeechRecognitionEngine.AudioFormat Property

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

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

Syntax

'Declaration
Public ReadOnly Property AudioFormat As SpeechAudioFormatInfo
    Get
'Usage
Dim instance As SpeechRecognitionEngine
Dim value As SpeechAudioFormatInfo

value = instance.AudioFormat

public SpeechAudioFormatInfo AudioFormat { get; }

Property Value

Type: Microsoft.Speech.AudioFormat.SpeechAudioFormatInfo
The format of audio at the input to the SpeechRecognitionEngine instance, or a null reference (Nothing in Visual Basic) if the input is not configured or set to the null input.

Remarks

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

• SetInputToAudioStream

• SetInputToDefaultAudioDevice

• SetInputToNull

• SetInputToWaveFile

• SetInputToWaveStream

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);
    }
  }
}

See Also

Reference

SpeechRecognitionEngine Class

SpeechRecognitionEngine Members

Microsoft.Speech.Recognition Namespace

SpeechAudioFormatInfo

SpeechRecognitionEngine