#include <TemplateRuntimeObserverInterface.h>

Inheritance diagram for alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeObserverInterface:

Classes
struct	AudioPlayerInfo

Public Member Functions
virtual	~TemplateRuntimeObserverInterface ()=default

virtual void	renderTemplateCard (const std::string &jsonPayload)=0

virtual void	renderPlayerInfoCard (const std::string &jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo)=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::templateRuntimeInterfaces::TemplateRuntimeObserverInterface::~TemplateRuntimeObserverInterface ( )

virtualdefault

Destructor

Member Function Documentation

◆ renderPlayerInfoCard()

virtual void alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeObserverInterface::renderPlayerInfoCard	(	const std::string &	jsonPayload,
		TemplateRuntimeObserverInterface::AudioPlayerInfo	audioPlayerInfo
	)

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

jsonPayload	The payload of the RenderPlayerInfo directive in structured JSON format.
audioPlayerInfo	Information on the `AudioPlayer`.

Implemented in alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapter.

◆ renderTemplateCard()

virtual void alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeObserverInterface::renderTemplateCard ( const std::string & jsonPayload )

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.

Implemented in alexaClientSDK::sampleApplications::common::TemplateRuntimePresentationAdapter, and alexaClientSDK::sampleApp::GuiRenderer.

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

/workplace/avs-device-sdk/capabilities/TemplateRuntime/TemplateRuntimeInterfaces/include/acsdk/TemplateRuntimeInterfaces/TemplateRuntimeObserverInterface.h