SpeechToTextSettingsModel

16 Mar 20261 minute to read

Interface for a class SpeechToTextSettings

Properties

allowInterimResults boolean

Specifies whether interim results should be captured during speech recognition.

buttonSettings ButtonSettingsModel

Configuration object for the mic button appearance and behavior.
Defines the button text, icons, position, and styling for both start and stop states.

cssClass string

Applies custom CSS classes to the speech-to-text component.

disabled boolean

Specifies whether the speech-to-text control is disabled.

enable boolean

Specifies whether speech-to-text functionality is enabled.

lang string

Specifies the language for speech recognition using ISO language codes.

listeningState SpeechToTextState

Indicates whether the component is currently listening.

showTooltip boolean

Specifies whether to show tooltip for the mic button.

tooltipSettings TooltipSettingsModel

Configuration object for tooltip appearance and behavior.
Defines the tooltip text and position for both listening and stop states.

transcript string

Stores the recognized speech transcript.
This property is read-only and updated when speech recognition results are received.

Events

onError EmitType<ErrorEventArgs>

Event raised when an error occurs during speech recognition.

onStart EmitType<StartListeningEventArgs>

Event raised when speech recognition starts.
Triggered when the user clicks the mic button and begins speaking.

onStop EmitType<StopListeningEventArgs>

Event raised when speech recognition stops.
Triggered when the user stops speaking and clicks the mic button.

transcriptChanged EmitType<TranscriptChangedEventArgs>

Event raised when the transcript changes during speech recognition.
Triggered for both interim results (if enabled) and final results.