![]() |
AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <GuiRenderer.h>
Public Member Functions | |
GuiRenderer () | |
bool | getGuiToggleState (const std::string &toggleName) |
returns the PlayerInfo toggle state More... | |
TemplateRuntimeObserverInterface Functions | |
void | renderTemplateCard (const std::string &jsonPayload, avsCommon::avs::FocusState focusState) override |
void | clearTemplateCard () override |
void | renderPlayerInfoCard (const std::string &jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo info, avsCommon::avs::FocusState focusState) override |
void | clearPlayerInfoCard () override |
![]() | |
virtual | ~TemplateRuntimeObserverInterface ()=default |
Static Public Attributes | |
static const std::string | TOGGLE_ACTION_SELECTED = "SELECTED" |
String to identify the AVS action SELECTED string. More... | |
static const std::string | TOGGLE_ACTION_DESELECTED = "DESELECTED" |
String to identify the AVS action DESELECTED string. More... | |
static const std::string | TOGGLE_NAME_SHUFFLE = "SHUFFLE" |
String to identify the AVS name SHUFFLE string. More... | |
static const std::string | TOGGLE_NAME_LOOP = "LOOP" |
String to identify the AVS name LOOP string. More... | |
static const std::string | TOGGLE_NAME_REPEAT = "REPEAT" |
String to identify the AVS name REPEAT string. More... | |
static const std::string | TOGGLE_NAME_THUMBSUP = "THUMBS_UP" |
String to identify the AVS name THUMBS_UP string. More... | |
static const std::string | TOGGLE_NAME_THUMBSDOWN = "THUMBS_DOWN" |
String to identify the AVS name THUMBS_DOWN string. More... | |
A class that implements the TemplateRuntimeObserverInterface. Instead of rendering the display cards, this class will print out some useful information (e.g. JSON payload) when the renderTemplateCard or renderPlayerInfoCard callbacks are called.
It is also used to track the PlayerInfo controls, and provide the PlayerInfo toggle states.
ACSDK_EMIT_SENSITIVE_LOGS
is ON. alexaClientSDK::sampleApp::GuiRenderer::GuiRenderer | ( | ) |
Constructor.
|
overridevirtual |
Used to notify the observer when the client should clear the PlayerInfo display card. Once the card is cleared, the client should call templateCardCleared().
Implements alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface.
|
overridevirtual |
Used to notify the observer when the client should clear the Template display card. Once the card is cleared, the client should call templateCardCleared().
Implements alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface.
bool alexaClientSDK::sampleApp::GuiRenderer::getGuiToggleState | ( | const std::string & | toggleName | ) |
returns the PlayerInfo toggle state
|
overridevirtual |
Used to notify the observer when a RenderPlayerInfo directive is received. Once called, the client should render the PlayerInfo display card based on the metadata provided in the payload in structured JSON format.
jsonPayload | The payload of the RenderPlayerInfo directive in structured JSON format. |
audioPlayerInfo | Information on the AudioPlayer . |
focusState | The FocusState of the channel used by TemplateRuntime interface. |
Implements alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface.
|
overridevirtual |
Used to notify the observer when a RenderTemplate directive is received. Once called, the client should render the Template display card based on the metadata provided in the payload in structured JSON format.
jsonPayload | The payload of the RenderTemplate directive in structured JSON format. |
focusState | The FocusState of the channel used by TemplateRuntime interface. |
Implements alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface.
|
static |
String to identify the AVS action DESELECTED string.
|
static |
String to identify the AVS action SELECTED string.
|
static |
String to identify the AVS name LOOP string.
|
static |
String to identify the AVS name REPEAT string.
|
static |
String to identify the AVS name SHUFFLE string.
|
static |
String to identify the AVS name THUMBS_DOWN string.
|
static |
String to identify the AVS name THUMBS_UP string.
AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0