alexaClientSDK::defaultClient::EqualizerRuntimeSetup Class Reference

#include <EqualizerRuntimeSetup.h>

Inheritance diagram for alexaClientSDK::defaultClient::EqualizerRuntimeSetup:

Collaboration diagram for alexaClientSDK::defaultClient::EqualizerRuntimeSetup:

Public Member Functions
	EqualizerRuntimeSetup (bool isEnabled=true)
void	setConfiguration (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface > configuration)
void	setStorage (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface > storage)
void	setModeController (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface > modeController)
EqualizerRuntimeSetupInterface functions
std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface >	getConfiguration () override
std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface >	getStorage () override
std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface >	getModeController () override
bool	addEqualizer (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface > equalizer) override
bool	addEqualizerControllerListener (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener) override
std::list< std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface > >	getAllEqualizers () override
std::list< std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > >	getAllEqualizerControllerListeners () override
bool	isEnabled () override
Public Member Functions inherited from alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface
virtual	~EqualizerRuntimeSetupInterface ()=default
virtual bool	addEqualizer (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface > equalizer)=0
virtual bool	addEqualizerControllerListener (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener)=0

Static Public Member Functions
static std::shared_ptr< EqualizerRuntimeSetupInterface >	createEqualizerRuntimeSetupInterface (const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface > &equalizerConfiguration, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface > &equalizerStorage, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface > &equalizerModeController)

Detailed Description

Class containing references to implementations for all equalizer related interfaces.

Constructor & Destructor Documentation

EqualizerRuntimeSetup()

alexaClientSDK::defaultClient::EqualizerRuntimeSetup::EqualizerRuntimeSetup

(

bool

isEnabled = true

)

Constructor.

Parameters

isEnabled

Whether equalizer is enabled; true by default.

Member Function Documentation

addEqualizer()

bool alexaClientSDK::defaultClient::EqualizerRuntimeSetup::addEqualizer ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface >  equalizer )

override

addEqualizerControllerListener()

bool alexaClientSDK::defaultClient::EqualizerRuntimeSetup::addEqualizerControllerListener ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface >  listener )

override

createEqualizerRuntimeSetupInterface()

static std::shared_ptr<EqualizerRuntimeSetupInterface> alexaClientSDK::defaultClient::EqualizerRuntimeSetup::createEqualizerRuntimeSetupInterface ( const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface > &  equalizerConfiguration, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface > &  equalizerStorage, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface > &  equalizerModeController  )

static

Factory method to create an instance of EqualizerRuntimeSetupInterface.

Parameters

equalizerConfiguration	Equalizer configuration instance.
equalizerStorage	Equalizer storage instance.
equalizerModeController	Equalizer mode controller instance.

Returns

An enabled EqualizerRuntimeSetup if equalizer is enabled in the configuration instance; otherwise, a disabled EqualizerRuntimeSetupInterface.

getAllEqualizerControllerListeners()

std::list<std::shared_ptr<acsdkEqualizerInterfaces::EqualizerControllerListenerInterface> > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getAllEqualizerControllerListeners ( )

overridevirtual

Returns a list of all equalizer controller listeners that are going to be used by the SDK.

Returns

List of all equalizer controller listeners that are going to be used by the SDK.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

getAllEqualizers()

std::list<std::shared_ptr<acsdkEqualizerInterfaces::EqualizerInterface> > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getAllEqualizers ( )

overridevirtual

Returns a list of all equalizers that are going to be used by the SDK.

Returns

List of all equalizers that are going to be used by the SDK.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

getConfiguration()

std::shared_ptr<acsdkEqualizerInterfaces::EqualizerConfigurationInterface> alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getConfiguration ( )

overridevirtual

Returns equalizer configuration instance.

Returns

Equalizer configuration instance.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

getModeController()

std::shared_ptr<acsdkEqualizerInterfaces::EqualizerModeControllerInterface> alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getModeController ( )

overridevirtual

Returns equalizer mode controller instance.

Returns

Equalizer mode controller instance.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

getStorage()

std::shared_ptr<acsdkEqualizerInterfaces::EqualizerStorageInterface> alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getStorage ( )

overridevirtual

Returns equalizer state storage instance.

Returns

Equalizer state storage instance.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

isEnabled()

bool alexaClientSDK::defaultClient::EqualizerRuntimeSetup::isEnabled ( )

overridevirtual

Whether the equalizer is enabled.

Returns

Whether the equalizer is enabled.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

setConfiguration()

void alexaClientSDK::defaultClient::EqualizerRuntimeSetup::setConfiguration

(

std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface >

configuration

)

Set equalizer configuration instance.

Parameters

configuration

Equalizer configuration instance.

setModeController()

void alexaClientSDK::defaultClient::EqualizerRuntimeSetup::setModeController

(

std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface >

modeController

)

Set equalizer mode controller instance.

Parameters

modeController

Equalizer mode controller instance.

setStorage()

void alexaClientSDK::defaultClient::EqualizerRuntimeSetup::setStorage

(

std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface >

storage

)

Set equalizer state storage instance.

Parameters

storage

Equalizer state storage instance.

---

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

• /workplace/avs-device-sdk/ApplicationUtilities/DefaultClient/include/DefaultClient/EqualizerRuntimeSetup.h