alexaClientSDK::featureClient::AlexaPresentationFeatureClient Class Reference

#include <AlexaPresentationFeatureClient.h>

Inheritance diagram for alexaClientSDK::featureClient::AlexaPresentationFeatureClient:

Collaboration diagram for alexaClientSDK::featureClient::AlexaPresentationFeatureClient:

Public Member Functions
std::shared_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentInterface >	getAPLCapabilityAgent () const
std::shared_ptr< alexaPresentationInterfaces::AlexaPresentationCapabilityAgentInterface >	getAlexaPresentationCapabilityAgent () const
void	addAPLCapabilityAgentObserver (std::weak_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > observer)
void	removeAPLCapabilityAgentObserver (std::weak_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface > observer)
	~AlexaPresentationFeatureClient ()
	Destructor. More...
bool	configure (const std::shared_ptr< alexaClientSDK::sdkClient::SDKClientRegistry > &sdkClientRegistry) override
void	doShutdown () override
Public Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientInterface
	FeatureClientInterface (const std::string &name)
virtual bool	configure (const std::shared_ptr< SDKClientRegistry > &sdkClientRegistry)=0
virtual	~FeatureClientInterface ()=default
	Destructor. More...
Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)
virtual	~RequiresShutdown ()
	Destructor. More...
const std::string &	name () const
void	shutdown ()
bool	isShutdown () const

Static Public Member Functions
static std::unique_ptr< AlexaPresentationFeatureClient >	create (std::string aplVersion, std::shared_ptr< aplCapabilityCommonInterfaces::VisualStateProviderInterface > stateProviderInterface, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface > &connectionManager, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &endpointBuilder, const std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder, const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry)

Additional Inherited Members

Detailed Description

The AlexaPresentationFeatureClient is a Feature Client that adds support for APL directives through the use of Alexa.Presentation, Alexa.Presentation.APL components. It is recommended that the AlexaPresentationFeatureClientBuilder is used in combination with the SDKClientBuilder to construct this Feature Client.

Constructor & Destructor Documentation

~AlexaPresentationFeatureClient()

alexaClientSDK::featureClient::AlexaPresentationFeatureClient::~AlexaPresentationFeatureClient

(

)

Destructor.

Member Function Documentation

addAPLCapabilityAgentObserver()

void alexaClientSDK::featureClient::AlexaPresentationFeatureClient::addAPLCapabilityAgentObserver

(

std::weak_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >

observer

)

Adds an observer to be notified of APL capability agent changes.

Parameters

observer

The APLCapabilityAgentObserverInterface to add; duplicate or null pointers will be ignored.

configure()

bool alexaClientSDK::featureClient::AlexaPresentationFeatureClient::configure ( const std::shared_ptr< alexaClientSDK::sdkClient::SDKClientRegistry > &  sdkClientRegistry )

override

FeatureClientInterface functions

create()

static std::unique_ptr<AlexaPresentationFeatureClient> alexaClientSDK::featureClient::AlexaPresentationFeatureClient::create ( std::string  aplVersion, std::shared_ptr< aplCapabilityCommonInterfaces::VisualStateProviderInterface >  stateProviderInterface, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface > &  connectionManager, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &  endpointBuilder, const std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder, const std::shared_ptr< sdkClient::SDKClientRegistry > &  sdkClientRegistry  )

static

Create the AlexaPresentationFeatureClient, this client must be provided to the ClientBuilder or added to an existing SDKClientRegistry

Parameters

aplVersion	The max supported APL Version
stateProviderInterface	The visual state provider interface
exceptionSender	Pointer to the ExceptionEncounteredSenderInterface
connectionManager	Pointer to the AVSConnectionManagerInterface
contextManager	Pointer to the ContextManagerInterface
endpointBuilder	Pointer to the EndpointBuilderInterface
metricRecorder	The MetricRecorderInterface - may be null if metrics are not required
sdkClientRegistry	Pointer to the SDKClientRegistry - may be null if not using the SDKClientRegistry

Returns

pointer to the AlexaPresentationFeatureClient, or nullptr if creation failed

doShutdown()

void alexaClientSDK::featureClient::AlexaPresentationFeatureClient::doShutdown ( )

overridevirtual

FeatureClientInterface functions

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

getAlexaPresentationCapabilityAgent()

std::shared_ptr<alexaPresentationInterfaces::AlexaPresentationCapabilityAgentInterface> alexaClientSDK::featureClient::AlexaPresentationFeatureClient::getAlexaPresentationCapabilityAgent

(

)

const

Get a reference to the AlexaPresentationCapabilityAgentInterface which is used to communicate with the Alexa.Presentation capability agent.

Returns

shared_ptr to the AlexaPresentationCapabilityAgentInterface

getAPLCapabilityAgent()

std::shared_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentInterface> alexaClientSDK::featureClient::AlexaPresentationFeatureClient::getAPLCapabilityAgent

(

)

const

Get a reference to the APLCapabilityAgentInterface which is used to communicate with the APL capability agent.

Returns

shared_ptr to the APLCapabilityAgentInterface

removeAPLCapabilityAgentObserver()

void alexaClientSDK::featureClient::AlexaPresentationFeatureClient::removeAPLCapabilityAgentObserver

(

std::weak_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface >

observer

)

Removes an observer to be notified of APL capability agent changes.

Parameters

observer

The APLCapabilityAgentObserverInterface to remove, no action will be taken if observer does not exist.

---

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

• /workplace/avs-device-sdk/applications/FeatureClients/AlexaPresentationFeatureClient/include/acsdk/AlexaPresentationFeatureClient/AlexaPresentationFeatureClient.h