SpeechTilesAndamento Docs
Get started
Configuration Reference

Interruption Event Behavior

Reusable JSON object structure, not a JSON property named interruptionEventBehavior. The JSON property is the category name (audioPlayback, audioRecording, speechRecognition, interactiveCapture, or interactivePlayback) under interruptionBehavior.

Category properties: audioPlayback · audioRecording · speechRecognition · interactiveCapture · interactivePlayback

JSON type object

Defines event policies for one Interruption Behavior category. Each event is optional, and its effective policy is resolved through the interruption-policy precedence chain.

Developer guidance

This page documents a reusable event-property structure, not a literal JSON property named interruptionEventBehavior. Each event property contains a policy, except the app background/foreground cases that select policies through whenAudioAllowed and whenAudioNotAllowed.

Example in context

Illustrative JSON excerpt (not a complete configuration document):

{
  "interruptionBehavior": {
    "audioPlayback": {
      "onAppEnterBackground": {
        "whenAudioAllowed": {
          "action": "continue"
        },
        "whenAudioNotAllowed": {
          "action": "pause"
        }
      }
    }
  }
}

This shows the extra policy level for the background event.

Properties

onConversationResume

objectOptional

JSON property onConversationResume · JSON type object. Interrupt Event Policy

onAudioInterruptionBegin

objectOptional

JSON property onAudioInterruptionBegin · JSON type object. Interrupt Event Policy

onAudioInterruptionEnd

objectOptional

JSON property onAudioInterruptionEnd · JSON type object. Interrupt Event Policy

onAudioRouteChange

objectOptional

JSON property onAudioRouteChange · JSON type object. Interrupt Event Policy

onAudioSilenceBegin

objectOptional

JSON property onAudioSilenceBegin · JSON type object. Interrupt Event Policy

onAudioSilenceEnd

objectOptional

JSON property onAudioSilenceEnd · JSON type object. Interrupt Event Policy

onAppResignActive

objectOptional

JSON property onAppResignActive · JSON type object. Interrupt Event Policy

onAppBecomeActive

objectOptional

JSON property onAppBecomeActive · JSON type object. Interrupt Event Policy

onAppEnterBackground

objectOptional

JSON property onAppEnterBackground · JSON type object. App Background Policy Uses whenAudioAllowed and whenAudioNotAllowed.

onAppEnterForeground

objectOptional

JSON property onAppEnterForeground · JSON type object. App Foreground Policy Uses whenAudioAllowed and whenAudioNotAllowed.

onAppRequiresForeground

objectOptional

JSON property onAppRequiresForeground · JSON type object. Interrupt Event Policy

onMediaServicesLost

objectOptional

JSON property onMediaServicesLost · JSON type object. Interrupt Event Policy

onMediaServicesReset

objectOptional

JSON property onMediaServicesReset · JSON type object. Interrupt Event Policy

onScreenSleepBegin

objectOptional

JSON property onScreenSleepBegin · JSON type object. Interrupt Event Policy

onScreenWake

objectOptional

JSON property onScreenWake · JSON type object. Interrupt Event Policy

onSystemSleepBegin

objectOptional

JSON property onSystemSleepBegin · JSON type object. Interrupt Event Policy

onSystemWake

objectOptional

JSON property onSystemWake · JSON type object. Interrupt Event Policy

App Background Policy

Reusable object structure (not a literal JSON property). The event property contains whenAudioAllowed and whenAudioNotAllowed, each an optional object containing an Interrupt Event Policy.

JSON property whenAudioAllowed · JSON type object · Interrupt Event Policy

JSON property whenAudioNotAllowed · JSON type object · Interrupt Event Policy

App Foreground Policy

Reusable object structure (not a literal JSON property). The event property contains whenAudioAllowed and whenAudioNotAllowed, each an optional object containing an Interrupt Event Policy.

JSON property whenAudioAllowed · JSON type object · Interrupt Event Policy

JSON property whenAudioNotAllowed · JSON type object · Interrupt Event Policy