#include <EqualizerCapabilityAgent.h>

Inheritance diagram for alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent:

[legend]

Collaboration diagram for alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent:

[legend]

Public Member Functions
	~EqualizerCapabilityAgent () override=default

CapabilityAgent Functions
avsCommon::avs::DirectiveHandlerConfiguration	getConfiguration () const override

void	handleDirectiveImmediately (std::shared_ptr< avsCommon::avs::AVSDirective > directive) override

void	preHandleDirective (std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info) override

void	handleDirective (std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info) override

void	cancelDirective (std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info) override

CapabilityConfigurationInterface Functions
std::unordered_set< std::shared_ptr< avsCommon::avs::CapabilityConfiguration > >	getCapabilityConfigurations () override

void	doShutdown () override

CustomerDataHandler Functions
void	clearData () override

EqualizerControllerListenerInterface Functions
void	onEqualizerStateChanged (const acsdkEqualizerInterfaces::EqualizerState &state) override

void	onEqualizerSameStateChanged (const acsdkEqualizerInterfaces::EqualizerState &state) override

Public Member Functions inherited from alexaClientSDK::acsdkEqualizerInterfaces::EqualizerControllerListenerInterface
virtual	~EqualizerControllerListenerInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
virtual	~CapabilityAgent ()=default

void	preHandleDirective (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result) override final

bool	handleDirective (const std::string &messageId) override final

void	cancelDirective (const std::string &messageId) override final

void	onDeregistered () override

void	onFocusChanged (FocusState newFocus, MixingBehavior behavior) override

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface
virtual	~DirectiveHandlerInterface ()=default

virtual void	preHandleDirective (std::shared_ptr< avsCommon::avs::AVSDirective > directive, std::unique_ptr< DirectiveHandlerResultInterface > result)=0

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface
virtual	~ChannelObserverInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface
virtual	~StateProviderInterface ()=default

virtual void	provideState (const avs::NamespaceAndName &stateProviderName, const ContextRequestToken stateRequestToken)

virtual void	provideState (const avs::CapabilityTag &stateProviderName, const ContextRequestToken stateRequestToken)

virtual bool	canStateBeRetrieved ()

virtual bool	hasReportableStateProperties ()

virtual bool	shouldQueryState ()

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface
virtual	~ContextRequesterInterface ()=default

virtual void	onContextAvailable (const std::string &jsonContext)

virtual void	onContextAvailable (const endpoints::EndpointIdentifier &endpointId, const avs::AVSContext &endpointContext, ContextRequestToken requestToken)

virtual void	onContextFailure (const ContextRequestError error)

virtual void	onContextFailure (const ContextRequestError error, ContextRequestToken token)

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface
virtual	~CapabilityConfigurationInterface ()=default

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

Public Member Functions inherited from alexaClientSDK::registrationManager::CustomerDataHandler
	CustomerDataHandler (const std::shared_ptr< registrationManager::CustomerDataManagerInterface > &dataManager)

virtual	~CustomerDataHandler ()

Public Member Functions inherited from alexaClientSDK::registrationManager::CustomerDataHandlerInterface
virtual	~CustomerDataHandlerInterface ()=default

Static Public Member Functions
static std::shared_ptr< EqualizerCapabilityAgent >	create (std::shared_ptr< acsdkEqualizer::EqualizerController > equalizerController, std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface > capabilitiesDelegate, std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface > equalizerStorage, std::shared_ptr< registrationManager::CustomerDataManagerInterface > customerDataManager, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender)

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
	CapabilityAgent (const std::string &nameSpace, std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender)

virtual std::shared_ptr< DirectiveInfo >	createDirectiveInfo (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result)

virtual void	preHandleDirective (std::shared_ptr< DirectiveInfo > info)=0

virtual void	handleDirective (std::shared_ptr< DirectiveInfo > info)=0

virtual void	cancelDirective (std::shared_ptr< DirectiveInfo > info)=0

void	removeDirective (const std::string &messageId)

void	sendExceptionEncounteredAndReportFailed (std::shared_ptr< DirectiveInfo > info, const std::string &message, avsCommon::avs::ExceptionErrorType type=avsCommon::avs::ExceptionErrorType::INTERNAL_ERROR)

const std::pair< std::string, std::string >	buildJsonEventString (const std::string &eventName, const std::string &dialogRequestIdString="", const std::string &payload="{}", const std::string &context="") const

Protected Attributes inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
const std::string	m_namespace
	The namespace of the capability agent. More...

std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface >	m_exceptionEncounteredSender
	Object to use to send exceptionEncountered messages. More...

Detailed Description

Capability Agent to handle EqualizerController AVS Interface.

Constructor & Destructor Documentation

◆ ~EqualizerCapabilityAgent()

alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::~EqualizerCapabilityAgent ( )

overridedefault

Destructor.

Member Function Documentation

◆ cancelDirective()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::cancelDirective ( std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info )

override

◆ clearData()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::clearData ( )

overridevirtual

Reset any internal state that may be associated with a particular user.

Warning: Object must succeed in deleting any customer data.; This method is called while CustomerDataManager is in a locked state. Do not call or wait for any CustomerDataManager operation.

Implements alexaClientSDK::registrationManager::CustomerDataHandlerInterface.

◆ create()

static std::shared_ptr<EqualizerCapabilityAgent> alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::create	(	std::shared_ptr< acsdkEqualizer::EqualizerController >	equalizerController,
		std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface >	capabilitiesDelegate,
		std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface >	equalizerStorage,
		std::shared_ptr< registrationManager::CustomerDataManagerInterface >	customerDataManager,
		std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >	exceptionEncounteredSender,
		std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >	contextManager,
		std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >	messageSender
	)

static

Factory method to create a capability agent instance.

Parameters

equalizerController	An SDK's component to control equalizer state and listen to its changes.
capabilitiesDelegate	Interface to control DCF configuration.
equalizerStorage	Interface to store equalizer state between runs.
customerDataManager	Component to register Capability Agent as customer data container (equalizer state).
exceptionEncounteredSender	Interface to report exceptions to AVS.
contextManager	Interface to provide equalizer state to AVS.
messageSender	Interface to send events to AVS.

Returns: A new instance of EqualizerCapabilityAgent on success, nullptr otherwise.

◆ doShutdown()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::doShutdown ( )

overridevirtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning

Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

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

◆ getCapabilityConfigurations()

std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration> > alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::getCapabilityConfigurations ( )

overridevirtual

Returns the configurations of the capability interfaces being implemented.

Returns: A set of CapabilityConfigurations

Implements alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface.

◆ getConfiguration()

avsCommon::avs::DirectiveHandlerConfiguration alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::getConfiguration ( ) const

overridevirtual

Returns the configuration of the directive handler.

The configuration consists of multiple directive routing rules and their respective blocking policy. The directives will be matched from the most specific rule (with all fields defined) to the least specific rule (which only matches the directive endpointId).

Returns: The avs::DirectiveHandlerConfiguration of the handler.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.

◆ handleDirective()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::handleDirective ( std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info )

override

◆ handleDirectiveImmediately()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::handleDirectiveImmediately ( std::shared_ptr< avsCommon::avs::AVSDirective > directive )

overridevirtual

Handle the action specified AVSDirective. Once this has been called the DirectiveHandler should not expect to receive further calls regarding this directive.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.; If this operation fails, an ExceptionEncountered message should be sent to AVS.

Parameters

directive The directive to handle.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.

◆ onEqualizerSameStateChanged()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::onEqualizerSameStateChanged ( const acsdkEqualizerInterfaces::EqualizerState & newState )

overridevirtual

Receives the same state of the EqualizerController when equalizer setting is changed but to an identical state to the current state. This callback is called after all changes has been applied.

Parameters

newState New state of the EqualizerController.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerControllerListenerInterface.

◆ onEqualizerStateChanged()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::onEqualizerStateChanged ( const acsdkEqualizerInterfaces::EqualizerState & newState )

overridevirtual

Receives the new state of the EqualizerController. This callback is called after all changes has been applied.

Parameters

newState New state of the EqualizerController.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerControllerListenerInterface.

◆ preHandleDirective()

void alexaClientSDK::acsdkEqualizer::EqualizerCapabilityAgent::preHandleDirective ( std::shared_ptr< avsCommon::avs::CapabilityAgent::DirectiveInfo > info )

override

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

/workplace/avs-device-sdk/capabilities/Equalizer/acsdkEqualizer/include/acsdkEqualizer/EqualizerCapabilityAgent.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~EqualizerCapabilityAgent()

Member Function Documentation

◆ cancelDirective()

◆ clearData()

◆ create()

◆ doShutdown()

◆ getCapabilityConfigurations()

◆ getConfiguration()

◆ handleDirective()

◆ handleDirectiveImmediately()

◆ onEqualizerSameStateChanged()

◆ onEqualizerStateChanged()

◆ preHandleDirective()