alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeInterface Class Reference

#include <TemplateRuntimeInterface.h>

Public Member Functions
virtual	~TemplateRuntimeInterface ()=default
virtual void	addObserver (std::weak_ptr< TemplateRuntimeObserverInterface > observer)=0
virtual void	removeObserver (std::weak_ptr< TemplateRuntimeObserverInterface > observer)=0
virtual void	addRenderPlayerInfoCardsProvider (std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderInterface > cardsProvider)=0

Detailed Description

This class defines a contract that an implementation of TemplateRuntime capability must fulfill. Application is expected to interact with TemplateRuntime by registering its observers and subscribe to GUI components that may provide user activity for playerInfo card.

Constructor & Destructor Documentation

~TemplateRuntimeInterface()

virtual alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeInterface::~TemplateRuntimeInterface ( )

virtualdefault

Destructor

Member Function Documentation

addObserver()

virtual void alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeInterface::addObserver ( std::weak_ptr< TemplateRuntimeObserverInterface >  observer )

pure virtual

This function adds an observer to TemplateRuntime so that it will get notified for renderTemplateCard or renderPlayerInfoCard.

Parameters

observer

The TemplateRuntimeObserverInterface

addRenderPlayerInfoCardsProvider()

virtual void alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeInterface::addRenderPlayerInfoCardsProvider ( std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderInterface >  cardsProvider )

pure virtual

This function adds a for a client to subscribe TemplateRuntime as an observer of changes for RenderPlayerInfoCards.

Parameters

cardsProvider

The RenderPlayerInfoCardsProviderInterface

removeObserver()

virtual void alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeInterface::removeObserver ( std::weak_ptr< TemplateRuntimeObserverInterface >  observer )

pure virtual

This function removes an observer from TemplateRuntime so that it will no longer be notified of renderTemplateCard or renderPlayerInfoCard callbacks.

Parameters

observer

The TemplateRuntimeObserverInterface

---

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

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