Alexa Auto SDK  2.0.0
Public Member Functions | List of all members
com.amazon.aace.alexa.TemplateRuntime Class Referenceabstract

Public Member Functions

void renderTemplate (String payload)
 
void renderPlayerInfo (String payload)
 
void clearTemplate ()
 
void clearPlayerInfo ()
 

Detailed Description

TemplateRuntime should be extended to handle directives from the Engine for rendering visual metadata with display cards. Metadata is provided as structured JSON and should be parsed by the platform implementation for rendering cards that adhere to design guidelines for the platform device type. For screen-specific design guidance, see the AVS UX Design Overview: https://developer.amazon.com/docs/alexa-voice-service/ux-design-overview.html#displaycards

Member Function Documentation

◆ renderTemplate()

void com.amazon.aace.alexa.TemplateRuntime.renderTemplate ( String  payload)

Provides visual metadata associated with a user request to Alexa. The platform implementation should parse the template metadata and render a display card for the user. For supported templates and rendering guidelines, see https://alexa.design/DevDocRenderTemplate

Parameters
payloadRenderable template metadata in structured JSON format

◆ renderPlayerInfo()

void com.amazon.aace.alexa.TemplateRuntime.renderPlayerInfo ( String  payload)

Provides visual metadata associated with a user request to Alexa for audio playback. The platform implementation should parse the player info metadata and render a display card for the user. For rendering guidelines, see https://amzn.to/DevDocTemplatePlayerInfo

Parameters
payloadRenderable player info metadata in structured JSON format
See also
PlaybackController
AudioPlayer

◆ clearTemplate()

void com.amazon.aace.alexa.TemplateRuntime.clearTemplate ( )

Notifies the platform implementation to dismiss the template display card

◆ clearPlayerInfo()

void com.amazon.aace.alexa.TemplateRuntime.clearPlayerInfo ( )

Notifies the platform implementation to dismiss the player info display card


Alexa Auto SDK 2.0.0 - Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0