Skip to main content
Version: 3.0.0

Speech Conditions

Speech Recognition​

The Speech Recognition condition checks whether the user speaks a phrase similar to one of the expected phrases. It uses the on-device Speech Recognition (Whisper) runtime to transcribe the microphone audio and compares it with the target phrases. The condition is satisfied when one of the phrases is recognized with at least the minimum confidence (or when the condition is skipped).

Speech Recognition condition

PropertyFunction
Can SkipAllows the condition to be skipped.
TextsThe list of phrases to recognize. The condition succeeds if the user says any of them.
LanguageThe language to recognize. Leave empty for automatic language detection.
Min ConfidenceThe minimum confidence (0–1) required to accept the recognized phrase. Default is 0.8.
Recognition ModeContinuos recognizes continuously while the user is talking; OnMute evaluates when the user stops talking.
Recognition OptionsFlags that tune the comparison: Ignore Punctuations (ignore punctuation when matching) and Middle Sentence (also match the phrase when it appears in the middle of a longer sentence). The inspector shows Everything when both are enabled.
Wait After RecognitionWait For End Of Speech keeps listening until the user stops talking after a phrase is recognized; No Wait completes as soon as the phrase is recognized.
End Of Speech Timeout(only with Wait For End Of Speech) Maximum time, in seconds, to wait for the user to stop speaking after a phrase is recognized. If no silence is detected within this time, recognition is forced to complete. Default is 2.
Target Step IDWhen enabled, lists the condition under the specified step.
Start SoundOptional sound played when recognition starts, with the execution modes it applies to.
Done SoundOptional sound played when a phrase has been recognized, with the execution modes it applies to.
DebugEnables debug feedback for the selected execution modes.
note

The recognition runs on-device with Whisper; the models live in StreamingAssets/WEAVR/Whisper/. See the Speech Recognition page for details on the models and the microphone.