This documentation is archived and is not being maintained.

SpeechUI Class

Provides text and status information on recognition operations to be displayed in the Speech platform user interface.


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

public class SpeechUI

The SpeechUI type exposes the following members.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberSendTextFeedbackSends status and descriptive text to the Speech platform user interface about the status of a recognition operation.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The members of the SpeechUI class can be used to indicate exact feedback to the end user through the speech recognition user interface. An application can return arbitrary text and success/failure information using this class. The following image shows the speech recognition user interface in Windows 7.

The following example is a handler for the SpeechRecognized event. This event is used by a Grammar that is designed to handle password input in the form "My password is …".

If a password is not present, or not valid, SendTextFeedback sends error information to the Speech platform user interface.

grammar.SpeechRecognized += 
delegate(object sender, SpeechRecognizedEventArgs eventArgs) 
  SemanticValue semantics = eventArgs.Result.Semantics;
  RecognitionResult result=eventArgs.Result;

  if (!semantics.ContainsKey("Password")) 
    SpeechUI.SendTextFeedback(eventArgs.Result, "No Password Provided", false);
    RecognizedAudio pwdAudio = result.GetAudioForWordRange(
                  result.Words[result.Words.Count - 1]);
    MemoryStream pwdMemoryStream = new MemoryStream();
    if (!IsValidPwd(pwdMemoryStream)) 
      string badPwd = System.IO.Path.GetTempPath() + 
              "BadPwd" + (new Random()).Next().ToString() + ".wav";
      FileStream waveStream = new FileStream(badPwd, FileMode.Create);
      SpeechUI.SendTextFeedback(eventArgs.Result, "Invalid Password", false);

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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