#include <LiveViewControllerFeatureClient.h>

Inheritance diagram for alexaClientSDK::featureClient::LiveViewControllerFeatureClient:

Collaboration diagram for alexaClientSDK::featureClient::LiveViewControllerFeatureClient:

Public Member Functions
	~LiveViewControllerFeatureClient ()
	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< LiveViewControllerFeatureClient >	create (avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId, const std::shared_ptr< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface > &liveViewController, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface > &connectionManager, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSender > &responseSender, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &endpointBuilder)

Additional Inherited Members

Detailed Description

The LiveViewControllerFeatureClient is a Feature Client that adds support for LiveViewController directives through the use of Alexa.Camera.LiveViewController components. It is recommended that the LiveViewControllerFeatureClientBuilder is used in combination with the SDKClientBuilder to construct this Feature Client.

Constructor & Destructor Documentation

◆ ~LiveViewControllerFeatureClient()

alexaClientSDK::featureClient::LiveViewControllerFeatureClient::~LiveViewControllerFeatureClient ( )

Destructor.

Member Function Documentation

◆ configure()

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

override

FeatureClientInterface functions

◆ create()

static std::unique_ptr<LiveViewControllerFeatureClient> alexaClientSDK::featureClient::LiveViewControllerFeatureClient::create	(	avsCommon::sdkInterfaces::endpoints::EndpointIdentifier	endpointId,
		const std::shared_ptr< alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface > &	liveViewController,
		const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface > &	connectionManager,
		const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > &	contextManager,
		const std::shared_ptr< alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSender > &	responseSender,
		const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &	exceptionSender,
		const std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > &	endpointBuilder
	)

static

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

Parameters

endpointId	An endpoint to which this capability is associated.
liveViewController	Pointer to the `LiveViewControllerInterface`.
connectionManager	Pointer to the `AVSConnectionManagerInterface`.
contextManager	Pointer to the `ContextManagerInterface`.
responseSender	Pointer to the `AlexaInterfaceMessageSender`.
exceptionSender	Pointer to the `ExceptionEncounteredSenderInterface`.
endpointBuilder	Pointer to the `EndpointBuilderInterface`

Returns: pointer to the LiveViewControllerFeatureClient, or nullptr if creation failed.

◆ doShutdown()

void alexaClientSDK::featureClient::LiveViewControllerFeatureClient::doShutdown ( )

overridevirtual

FeatureClientInterface functions

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

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

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

Public Member Functions

Static Public Member Functions