RecognizedAudio Class

Article
10/07/2009

Represents audio input a recognition engine used to generate candidate phrases result.

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class RecognizedAudio

[SerializableAttribute] 
public class RecognizedAudio

[SerializableAttribute] 
public ref class RecognizedAudio

/** @attribute SerializableAttribute() */ 
public class RecognizedAudio

SerializableAttribute 
public class RecognizedAudio

Remarks

Instances of RecognizedAudio are typically obtained from Audio property on an object derived from RecognitionResult and passed by a speech recognition engine to handlers of SpeechHypothesized, SpeechRecognized or SpeechRecognitionRejected events generated by SpeechRecognizer and SpeechRecognitionEngine, as well as SpeechRecognized events generated by Grammar.

Note

Instances of RecognizedAudio obtained by emulated speed recognition are null. For more information on emulated speech recognition, see EmulateRecognize and EmulateRecognizeAsync.

Inheritance Hierarchy

System.Object
Microsoft.Speech.Recognition.RecognizedAudio

Example

In the example below, an application first checks to see if the recognition operation has been emulated by determining if the RecognizedAudio object received is non null. If the RecognizedAudio object is non-null information about the recognized audio is written to a Windows.Forms.Label for display.

    if (result != null) { //Clear
    RecognizedAudio resultRecognizedAudio = result.Audio;
    if (resultRecognizedAudio == null) {
        label.Text += String.Format(
            "  Emulated input\n");
    } else {
        label.Text += String.Format(
        "  Candidate Phrase at:       {0} mSec\n" +
        "  Phrase Length:             {1} mSec\n" +
        "  Input State Time:          {2}\n" +
        "  Input Format:              {3}\n",
        resultRecognizedAudio.AudioPosition.TotalMilliseconds,
        resultRecognizedAudio.Duration.TotalMilliseconds,
        resultRecognizedAudio.StartTime.ToShortTimeString(),
        resultRecognizedAudio.Format.EncodingFormat.ToString());
    }

Thread Safety

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

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

RecognizedAudio Class

Syntax

Remarks

Inheritance Hierarchy

Example

Thread Safety

Platforms

Development Platforms

Target Platforms

See Also

Reference

Additional resources