AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::featureClient::AlexaPresentationFeatureClient Class Reference

#include <AlexaPresentationFeatureClient.h>

Inheritance diagram for alexaClientSDK::featureClient::AlexaPresentationFeatureClient:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::featureClient::AlexaPresentationFeatureClient:
Collaboration graph
[legend]

Public Member Functions

std::shared_ptr< aplCapabilityCommonInterfaces::APLCapabilityAgentInterfacegetAPLCapabilityAgent () const
 
std::shared_ptr< alexaPresentationInterfaces::AlexaPresentationCapabilityAgentInterfacegetAlexaPresentationCapabilityAgent () 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< AlexaPresentationFeatureClientcreate (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
observerThe 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
aplVersionThe max supported APL Version
stateProviderInterfaceThe visual state provider interface
exceptionSenderPointer to the ExceptionEncounteredSenderInterface
connectionManagerPointer to the AVSConnectionManagerInterface
contextManagerPointer to the ContextManagerInterface
endpointBuilderPointer to the EndpointBuilderInterface
metricRecorderThe MetricRecorderInterface - may be null if metrics are not required
sdkClientRegistryPointer 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
observerThe APLCapabilityAgentObserverInterface to remove, no action will be taken if observer does not exist.

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

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