SpeechRecoContext RequestedUIType Property

Microsoft Speech SDK

Intelligent Interface Technologies Home Page Microsoft Speech SDK

Speech Automation 5.1

Interface: ISpeechRecoContext

RequestedUIType Property


The RequestedUIType property specifies the UIType of the last UI requested from the engine.

After a speech recognition (SR) engine sends a RequestUI event, the UIType persists until the next RequestUI event. This way the application can check for the last requested UI type. If no UI has been requested, the UIType string will be Empty.


Syntax

Set: (This property is read-only)
Get: String = SpeechRecoContext.RequestedUIType

Parts

SpeechRecoContext
The owning object.
String
Set: (This property is read-only)
Get: A String variable specifying the UIType. The UIType is a String corresponding to the UI requested. For a list of available SAPI 5 UI, see Engine User Interfaces.

Remarks

See RequestUI event, ISpeechRecognizer.DisplayUI, and Engine User Interfaces for more information.

Example

The following code snippet demonstrates retrieving the UI last requested from the engine. Due to the complexity of replicating a RequestUI, this is not a complete code sample.

This sample assumes a valid RC as the recognition context.

Dim theUI As String
theUI = RC.RequestedUIType