VisualActivityTracker Interface (v1.0)

Focus management improves the accuracy of responses from Alexa, specifically, when a user makes an ambiguous request. Focus is managed in the cloud. A client simply informs Alexa which interface has focus of a visual channel. This state information is sent in the context container under the VisualActivityTracker namespace.

See Focus Management for common use cases, and a complete interface to channel mapping.

Capabilities API

To use version 1.0 of the VisualActivityTracker interface, it must be declared in your call to the Capabilities API. For additional details, see Capabilities API.

{
    "type": "AlexaInterface",
    "interface": "VisualActivityTracker",
    "version": "1.0"
}

VisualActivityTracker Context

This context object lets Alexa know that the client is actively displaying Alexa-provided content to the user. If the Alexa content has been dismissed, VisualActivityTracker should not be included in the context.

{
    "header": {
        "namespace": "VisualActivityTracker",
        "name": "ActivityState"
    },
    "payload": {
        "focused": {
            "interface": "{{STRING}}",
        }
    }
}

Payload Parameters

Parameter Description Type
focused An object that contains information about the interface that currently has visual focus. object
focused.interface Specifies the interface that has visual focus.
Accepted Value: "TemplateRuntime"
string