AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface Class Referenceabstract

#include <TemplateRuntimeObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface:
Inheritance graph
[legend]

Classes

struct  AudioPlayerInfo
 

Public Member Functions

virtual ~TemplateRuntimeObserverInterface ()=default
 
virtual void renderTemplateCard (const std::string &jsonPayload, avsCommon::avs::FocusState focusState)=0
 
virtual void clearTemplateCard ()=0
 
virtual void renderPlayerInfoCard (const std::string &jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo, avsCommon::avs::FocusState focusState)=0
 
virtual void clearPlayerInfoCard ()=0
 

Detailed Description

This TemplateRuntimeObserverInterface class is used to notify observers when a RenderTemplate or RenderPlayerInfo directive is received. These two directives contains metadata for rendering display cards for devices with GUI support.

Constructor & Destructor Documentation

◆ ~TemplateRuntimeObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface::~TemplateRuntimeObserverInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ clearPlayerInfoCard()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface::clearPlayerInfoCard ( )
pure virtual

Used to notify the observer when the client should clear the PlayerInfo display card. Once the card is cleared, the client should call templateCardCleared().

Implemented in alexaClientSDK::sampleApp::GuiRenderer.

◆ clearTemplateCard()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface::clearTemplateCard ( )
pure virtual

Used to notify the observer when the client should clear the Template display card. Once the card is cleared, the client should call templateCardCleared().

Implemented in alexaClientSDK::sampleApp::GuiRenderer.

◆ renderPlayerInfoCard()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface::renderPlayerInfoCard ( const std::string &  jsonPayload,
TemplateRuntimeObserverInterface::AudioPlayerInfo  audioPlayerInfo,
avsCommon::avs::FocusState  focusState 
)
pure virtual

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.

Parameters
jsonPayloadThe payload of the RenderPlayerInfo directive in structured JSON format.
audioPlayerInfoInformation on the AudioPlayer.
focusStateThe FocusState of the channel used by TemplateRuntime interface.

Implemented in alexaClientSDK::sampleApp::GuiRenderer.

◆ renderTemplateCard()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface::renderTemplateCard ( const std::string &  jsonPayload,
avsCommon::avs::FocusState  focusState 
)
pure virtual

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.

Note
The payload may contain customer sensitive information and should be used with utmost care. Failure to do so may result in exposing or mishandling of customer data.
Parameters
jsonPayloadThe payload of the RenderTemplate directive in structured JSON format.
focusStateThe FocusState of the channel used by TemplateRuntime interface.

Implemented in alexaClientSDK::sampleApp::GuiRenderer.


The documentation for this class was generated from the following file:

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0