SpeechRecognizerUIOptions SpeechRecognizerUIOptions SpeechRecognizerUIOptions SpeechRecognizerUIOptions Class

Definition

Specifies the UI settings for the SpeechRecognizer.RecognizeWithUIAsync method.

public : sealed class SpeechRecognizerUIOptions : ISpeechRecognizerUIOptionspublic sealed class SpeechRecognizerUIOptions : ISpeechRecognizerUIOptionsPublic NotInheritable Class SpeechRecognizerUIOptions Implements ISpeechRecognizerUIOptions// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

An app retrieves this object through the SpeechRecognizer.UIOptions property.

Properties

AudiblePrompt AudiblePrompt AudiblePrompt AudiblePrompt

Gets or sets the heading text that is displayed on the Listening screen. The default is "Listening...".

public : PlatForm::String AudiblePrompt { get; set; }public string AudiblePrompt { get; set; }Public ReadWrite Property AudiblePrompt As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The heading text. A custom string should clearly describe the kind of info expected by the app and is limited to two lines in length.

Remarks

The default string is automatically localized: If the speech recognizer has an associated language, the default text is shown in that language. Otherwise, the default text is shown in the system language.

You are responsible for localizing a custom string.

See Also

ExampleText ExampleText ExampleText ExampleText

Gets or sets the example text shown on the Listening screen.

public : PlatForm::String ExampleText { get; set; }public string ExampleText { get; set; }Public ReadWrite Property ExampleText As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The example text that is shown on the Listening screen.

See Also

IsReadBackEnabled IsReadBackEnabled IsReadBackEnabled IsReadBackEnabled

Gets or sets whether the recognized text is spoken back to the user on the Heard you say screen.

public : PlatForm::Boolean IsReadBackEnabled { get; set; }public bool IsReadBackEnabled { get; set; }Public ReadWrite Property IsReadBackEnabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if the recognized text is spoken back to the user. Otherwise, false. The default is true.

See Also

ShowConfirmation ShowConfirmation ShowConfirmation ShowConfirmation

Gets or sets whether a Heard you say screen is shown to the user after speech recognition is completed.

public : PlatForm::Boolean ShowConfirmation { get; set; }public bool ShowConfirmation { get; set; }Public ReadWrite Property ShowConfirmation As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if a Heard you say screen is shown. Otherwise, false. The default is true.

See Also

See Also