SpeechRecognitionEngine.AudioFormat Property

Definition

Namespace:

System.Speech.Recognition

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

Source:

SpeechRecognitionEngine.cs

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

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

public System.Speech.AudioFormat.SpeechAudioFormatInfo AudioFormat { get; }

member this.AudioFormat : System.Speech.AudioFormat.SpeechAudioFormatInfo

Public ReadOnly Property AudioFormat As SpeechAudioFormatInfo

Property Value

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.

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

Remarks

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

• SetInputToAudioStream

• SetInputToDefaultAudioDevice

• SetInputToNull

• SetInputToWaveFile

• SetInputToWaveStream

See also

• SpeechAudioFormatInfo
• AudioFormat