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

Classes

enum  FocusState
 
enum  PlayerActivity
 

Public Member Functions

void renderTemplate (String payload)
 
void renderTemplate (String payload, FocusState focusState)
 
void renderPlayerInfo (String payload)
 
void renderPlayerInfo (String payload, PlayerActivity audioPlayerState, long offset, FocusState focusState)
 
void clearTemplate ()
 
void clearPlayerInfo ()
 
final void displayCardCleared ()
 

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() [1/2]

void com.amazon.aace.alexa.TemplateRuntime.renderTemplate ( String  payload)
Deprecated:
Use renderTemplate( String payload, FocusState focusState ).

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
[in]payloadRenderable template metadata in structured JSON format

◆ renderTemplate() [2/2]

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

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
[in]payloadRenderable template metadata in structured JSON format
[in]focusStateThe FocusState of the channel used by TemplateRuntime interface

◆ renderPlayerInfo() [1/2]

void com.amazon.aace.alexa.TemplateRuntime.renderPlayerInfo ( String  payload)
Deprecated:
Use renderPlayerInfo( String payload, PlayerActivity audioPlayerState, long offset, FocusState focusState ).

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
[in]payloadRenderable player info metadata in structured JSON format
See also
PlaybackController
AudioPlayer

◆ renderPlayerInfo() [2/2]

void com.amazon.aace.alexa.TemplateRuntime.renderPlayerInfo ( String  payload,
PlayerActivity  audioPlayerState,
long  offset,
FocusState  focusState 
)

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. The audioPlayerState and offset are useful for implementing the progress bar in the display card. It is assumed that the client is responsible for progressing the progress bar when the AudioPlayer is in PLAYING state.

For rendering guidelines, see https://amzn.to/DevDocTemplatePlayerInfo

Parameters
[in]payloadRenderable player info metadata in structured JSON format
[in]audioPlayerStateThe state of the AudioPlayer
[in]offsetThe offset in millisecond of the media that AudioPlayer is handling
[in]focusStateThe FocusState of the channel used by TemplateRuntime interface
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

◆ displayCardCleared()

final void com.amazon.aace.alexa.TemplateRuntime.displayCardCleared ( )

Notifies the Engine that a display card has been cleared from the screen. Upon getting this notification, the TemplateRuntime will release the visual channel.


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