#include <PresentationOrchestratorFeatureClient.h>

Inheritance diagram for alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient:

Collaboration diagram for alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient:

Public Member Functions
std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorClientInterface >	getPresentationOrchestratorClient () const

std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorInterface >	getPresentationOrchestrator () const

std::shared_ptr< presentationOrchestratorInterfaces::VisualTimeoutManagerInterface >	getVisualTimeoutManager () const

	~PresentationOrchestratorFeatureClient ()
	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< PresentationOrchestratorFeatureClient >	create (const std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface > &presentationOrchestratorStateTracker, const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry)

Additional Inherited Members

Detailed Description

The PresentationOrchestratorFeatureClient is a Feature Client that provides functionality to manage and track the lifecycle of presentations across multiple windows through the use of the PresentationOrchestrator, PresentationOrchestratorClient and VisualTimeoutManager components. It is recommended that the PresentationOrchestratorFeatureClientBuilder is used in combination with the SDKClientBuilder to construct this Feature Client.

Constructor & Destructor Documentation

◆ ~PresentationOrchestratorFeatureClient()

alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient::~PresentationOrchestratorFeatureClient ( )

Destructor.

Member Function Documentation

◆ configure()

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

override

FeatureClientInterface functions

◆ create()

static std::unique_ptr<PresentationOrchestratorFeatureClient> alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient::create	(	const std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface > &	presentationOrchestratorStateTracker,
		const std::shared_ptr< sdkClient::SDKClientRegistry > &	sdkClientRegistry
	)

static

Create an instance of the PresentationOrchestratorFeatureClient, it is recommended that the PresentationOrchestratorFeatureClientBuilder is used to create and register an instance of this client with the SDKClientRegistry

Parameters

presentationOrchestratorStateTracker	Reference to the `PresentationOrchestratorStateTrackerInterface`
sdkClientRegistry	Reference to the `SDKClientRegistry`, used to register components

Returns: Pointer to the newly created PresentationOrchestratorFeatureClient, or nullptr on failure

◆ doShutdown()

void alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient::doShutdown ( )

overridevirtual

FeatureClientInterface functions

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

◆ getPresentationOrchestrator()

std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorInterface> alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient::getPresentationOrchestrator ( ) const

Get a reference to PresentationOrchestratorInterface

Returns: shared_ptr to PresentationOrchestratorInterface

◆ getPresentationOrchestratorClient()

std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorClientInterface> alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient::getPresentationOrchestratorClient ( ) const

Get a reference to PresentationOrchestratorClientInterface

Returns: shared_ptr to PresentationOrchestratorClientInterface

◆ getVisualTimeoutManager()

std::shared_ptr<presentationOrchestratorInterfaces::VisualTimeoutManagerInterface> alexaClientSDK::featureClient::PresentationOrchestratorFeatureClient::getVisualTimeoutManager ( ) const

Get a reference to VisualTimeoutManagerInterface

Returns: shared_ptr to VisualTimeoutManagerInterface

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

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

Public Member Functions

Static Public Member Functions