Microsoft Speech SDK

Speech Automation 5.1

---

Object: SpVoice

DisplayUI Method

The DisplayUI method initiates the display of the specified UI.

The speech recognition (SR) and text-to-speech (TTS) engines are capable of displaying and running various user interfaces (UI). These displays assist with different aspects of the speech environment such as user training, microphone wizards, adding and removing words, or setting controls for the engine. Many of these UIs are available using Speech properties in Control Panel. In addition, the engines are capable of requesting that the user run specific UIs to improve recognition. For example, the SR engine could request more user training if recognition is consistently poor.

Engines are not required to support UI and not all engines will have the same UI. Consult the manufacturer's engine documentation for specific details. An application may call IsUISupported before attempting to invoke a particular UI to see if the engine supports it. Invoking unsupported UIs will cause a run-time error. If the UI is available, use DisplayUI to invoke the display.

SpVoice.DisplayUI(
     hWndParent As Long,
     Title As String,
     TypeOfUI As String,
     [ExtraData As Variant = Nothing]
)

Parameters

hWndParent

Specifies the window handle of the owning window.

Title

Specifies the caption used for the UI window.

TypeOfUI

A String specifying the name of the UI to display. For a list of available SAPI 5 UI, see Engine User Interfaces.

ExtraData

[Optional] Specifies the ExtraData. This information is unique to the application and may be used to provide additional or more specific information to the UI. By default, the Nothing value is used and indicates that the UI does not use any additional information provided by this method.

Return Value

None.

Remarks

See SPVoice.IsUISupported for additional information.

Example

The following Visual Basic form code demonstrates the use of the DisplayUI and IsUISupported methods. The application runs the audio sound panel, the same sound panel that is available using Speech properties in Control Panel.

To run this code, create a single form without any items on it. Paste this code into the Declarations section of the form.

Option Explicit
Public WithEvents vox As SpeechLib.SpVoice

Private Sub Form_Load()
    Set vox = New SpVoice
    RunUI SpeechAudioVolume
End Sub

Private Function RunUI(theUI As String)
    Dim x As Boolean
    
    If vox.IsUISupported(theUI) = True Then
        vox.DisplayUI Form1.hWnd, "My App's Sound Levels", theUI, vbNullString
    Else
        MsgBox theUI & " UI not supported"
    End If
End Function