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::VisualStateTrackerFeatureClient Class Reference

#include <VisualStateTrackerFeatureClient.h>

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

Public Member Functions

std::shared_ptr< alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterfacegetPresentationOrchestratorStateTracker () const
 
 ~VisualStateTrackerFeatureClient ()
 Destructor. More...
 
bool configure (const std::shared_ptr< 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< VisualStateTrackerFeatureClientcreate (const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &endpointBuilder, const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry)
 

Additional Inherited Members

Detailed Description

The VisualStateTrackerFeatureClient is a Feature Client that provides visual state tracking functionality through the use of the VisualActivityTracker and PresentationOrchestratorStateTracker components. It is recommended that the VisualStateTrackerFeatureClientBuilder is used in combination with the SDKClientBuilder to construct this Feature Client.

Constructor & Destructor Documentation

◆ ~VisualStateTrackerFeatureClient()

alexaClientSDK::featureClient::VisualStateTrackerFeatureClient::~VisualStateTrackerFeatureClient ( )

Destructor.

Member Function Documentation

◆ configure()

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

FeatureClientInterface functions

◆ create()

static std::unique_ptr<VisualStateTrackerFeatureClient> alexaClientSDK::featureClient::VisualStateTrackerFeatureClient::create ( const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager,
const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &  endpointBuilder,
const std::shared_ptr< sdkClient::SDKClientRegistry > &  sdkClientRegistry 
)
static

Create an instance of the VisualStateTrackerFeatureClient, it is recommended that the VisualStateTrackerFeatureClientBuilder is used to create and register an instance of this client with the SDKClientBuilder or SDKClientRegistry

Parameters
contextManagerPointer to the ContextManagerInterface to allow capabilities to receive context
endpointBuilderPointer to the EndpointBuilderInterface for registering capabilities
sdkClientRegistryReference to the SDKClientRegistry used to register
Returns
unique pointer to the created VisualStateTrackerFeatureClient, or nullptr if creation failed

◆ doShutdown()

void alexaClientSDK::featureClient::VisualStateTrackerFeatureClient::doShutdown ( )
overridevirtual

FeatureClientInterface functions

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

◆ getPresentationOrchestratorStateTracker()

std::shared_ptr<alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface> alexaClientSDK::featureClient::VisualStateTrackerFeatureClient::getPresentationOrchestratorStateTracker ( ) const

Get a reference to PresentationOrchestratorStateTrackerInterface

Returns
shared_ptr to PresentationOrchestratorStateTrackerInterface

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