#include <AlexaSeekControllerFactory.h>

Classes
struct	AlexaSeekControllerCapabilityAgentData
	This structure contains the interfaces used to interact with the AlexaSeekController Capability Agent. More...

Static Public Member Functions
static avsCommon::utils::Optional< AlexaSeekControllerCapabilityAgentData >	create (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, std::shared_ptr< acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface > seekController, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, bool isRetrievable)

Detailed Description

This factory can be used to create a new AlexaSeekControllerCapabilityAgent and return a generic object that contains certain interfaces which can be used for registering this capability agent to an endpoint.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<AlexaSeekControllerCapabilityAgentData> alexaClientSDK::acsdkAlexaSeekController::AlexaSeekControllerFactory::create	(	const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &	endpointId,
		std::shared_ptr< acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface >	seekController,
		const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &	contextManager,
		const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &	responseSender,
		const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &	exceptionSender,
		bool	isRetrievable
	)

static

Creates a new AlexaSeekController capability agent instance and exposes the AlexaSeekController related interfaces to the caller, including the handler for performing seek operations directiveHandler, the capability configurations associated to the capability agent instance capabilityConfigurationInterface, and the object for cleaning up the capability agent instance during shutdown requiresShutdown.

Parameters

endpointId	A endpoint to which this capability is associated.
seekController	An interface that this object will use to perform the seek controller operations.
contextManager	An interface to which this object will send property state updates.
responseSender	An interface that this object will use to send the reponse to AVS.
exceptionSender	An interface to report exceptions to AVS.
isRetrievable	Whether properties can be retrieved when Alexa sends a state report request or the endpoint responds with an Alexa response to a directive.

Returns: An Optional object with no valid value if the inputs are invalid, else a new AlexaSeekControllerCapabilityAgentData object.

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

/workplace/avs-device-sdk/capabilities/AlexaSeekController/acsdkAlexaSeekController/include/acsdkAlexaSeekController/AlexaSeekControllerFactory.h

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ create()