InteractionManager 1
The InteractionManager
interface exposes directives and events to enable the inter-process communication (IPC) client to control and respond to Alexa client changes.
Header
{
"namespace": "InteractionManager",
"version": 1
}
Directives
There are no directives.
Events
Inbound messages from the IPC client about interactions with the Alexa client.
guiActivityEvent
Send this event to inform the Alexa client of changes in the IPC client graphic user interface (GUI) activity that might impact the Alexa client behavior.
Example message
{ "header": { "version": 1 "namespace": "InteractionManager", "name": "`guiActivityEvent`" }, "payload": { "event": "{{STRING}}" } }
Payload parameters
Parameter | Description | Type |
---|---|---|
event |
Enumerated GUI activity event. | Valid values:ACTIVATED - GUI is switched to active stateDEACTIVATED - GUI becomes inactiveINTERRUPT - Interrupt event (cursor, touch, or click) |
navigationEvent
Send this event to control Alexa client state about BACK
and EXIT
navigation. Usually the event is sent as the result of some user interaction with a GUI or physical button interaction with the IPC client, such as the press of a back button on a remote control.
Example message
{ "header": { "version": 1 "namespace": "InteractionManager", "name": "navigationEvent" }, "payload": { "event": "{{STRING}}" } }
Payload parameters
Parameter | Description | Type |
---|---|---|
event |
Enumerated Navigation event type. | Valid values:BACK - For back navigation within the Alexa clientEXIT - To exit the Alexa client |
recognizeSpeechRequest
Send this event to instruct the Alexa client to open or close the microphone to start an Alexa interaction through the SpeechRecognizer.Recognize
AVS event with the provided initiatorType
.
Example message
{ "header": { "version": 1 "namespace": "InteractionManager", "name": "recognizeSpeechRequest" }, "payload": { "initiatorType": "{{STRING}}", "captureState" : "{{STRING}}, } }
Payload parameters
Parameter | Description | Type |
---|---|---|
initiatorType |
Action taken by a user to start an interaction with Alexa. | PRESS_AND_HOLD , TAP |
captureState |
Indicates if the request is to start or stop speech recognition capture. | START, STOP |
STOP
is only supported for the PRESS_AND_HOLD
initiator type. TAP
initiations are only stopped through the StopCapture
AVS directive.Related topics
Last updated: Apr 11, 2022