Format Property

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Gets the format of the audio processed by a recognition engine.

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

Syntax

Visual Basic (Declaration)
Public ReadOnly Property Format As SpeechAudioFormatInfo
	Get
Visual Basic (Usage)
Dim instance As RecognizedAudio
Dim value As SpeechAudioFormatInfo

value = instance.Format
C#
public SpeechAudioFormatInfo Format { get; }

Property Value

Type: Microsoft.Speech.AudioFormat..::..SpeechAudioFormatInfo

The format of the audio processed by the speech recognizer.

Examples

The following example handles the SpeechRecognitionEngine..::..SpeechRecognized event and outputs to the console information about the recognized audio that is associated with the recognition result.

C# Copy imageCopy Code
// Handle the SpeechRecognized event. 
void SpeechRecognizedHandler(object sender, SpeechRecognizedEventArgs e)
{
  if (e.Result == null) return;

  RecognitionResult result = e.Result;
  
  Console.WriteLine("Grammar({0}): {1}",
    result.Grammar.Name, result.Text);

  if (e.Result.Audio != null)
  {
    RecognizedAudio audio = e.Result.Audio;

    Console.WriteLine("   start time: {0}", audio.StartTime);
    Console.WriteLine("   encoding format: {0}", audio.Format.EncodingFormat);
    Console.WriteLine("   position: {0}, duration: {1}",
      audio.AudioPosition, audio.Duration);
  }

  // Add event handler code here.
}

See Also