#include <TemplateRuntimeObserverInterface.h>
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.
◆ ~TemplateRuntimeObserverInterface()
virtual alexaClientSDK::avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface::~TemplateRuntimeObserverInterface |
( |
| ) |
|
|
virtualdefault |
◆ 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()
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
-
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. |
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
-
jsonPayload | The payload of the RenderTemplate directive in structured JSON format. |
focusState | The 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.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0