For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
      • Overview
        • ASR
        • ASRDictionary
        • ASREvents
        • ASRLanguage
        • ASRModel
        • ASRProfile
        • Voice
        • TranscriptionProvider
        • TTSEffectsProfile
        • DialogflowLanguage
        • DialogflowModel
        • DialogflowModelVariant
        • DialogflowSsmlVoiceGender
  • Management API
    • Reference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Values
VoxEngineSpeech, ASR, and TTS

ASREvents

Add the following line to your scenario code to use the events: require(Modules.ASR);

||View as Markdown|
Was this page helpful?
Edit this page
Previous

ASRDictionary

Next

ASRLanguage

Built with

Values

ASRError
'ASR.Error'

Triggers in case of errors during the recognition process.

Started
'ASR.Started'

Triggers after ASR instance is created.

CaptureStarted
'ASR.CaptureStarted'

Triggers after ASR detected voice input and started collecting audio data for ASR.

SpeechCaptured
'ASR.SpeechCaptured'

Triggers after ASR captured audio data, before recognition process.

Result
'ASR.Result'

Triggered when a speech recognition result has been received from ASR. We strongly recommend to create recognition timeout manually to prevent unexpectedly long recognition time. NOTE: we recommend to take a decision about continuing speech recognition in this event’s handler. Otherwise, speech recognition continues automatically.

InterimResult
'ASR.InterimResult'

Triggered when interim recognition result received from ASR. Note that event could be triggered only if the ASRParameters.interimResults option is set to true.

Stopped
'ASR.Stopped'

Triggers as a result of the ASR.stop method call.