#include <InMemoryEqualizerConfiguration.h>

Inheritance diagram for alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration:

Collaboration diagram for alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration:

Public Member Functions
	~InMemoryEqualizerConfiguration () override=default

EqualizerConfigurationInterface functions
bool	isEnabled () const override

std::set< acsdkEqualizerInterfaces::EqualizerBand >	getSupportedBands () const override

std::set< acsdkEqualizerInterfaces::EqualizerMode >	getSupportedModes () const override

int	getMinBandLevel () const override

int	getMaxBandLevel () const override

int	getDefaultBandDelta () const override

acsdkEqualizerInterfaces::EqualizerState	getDefaultState () const override

bool	isBandSupported (acsdkEqualizerInterfaces::EqualizerBand band) const override

bool	isModeSupported (acsdkEqualizerInterfaces::EqualizerMode mode) const override

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

Static Public Member Functions
static std::shared_ptr< InMemoryEqualizerConfiguration >	create (int minBandLevel, int maxBandLevel, int defaultDelta, const std::set< acsdkEqualizerInterfaces::EqualizerBand > &bandsSupported, const std::set< acsdkEqualizerInterfaces::EqualizerMode > &modesSupported, acsdkEqualizerInterfaces::EqualizerState defaultState)

static std::shared_ptr< InMemoryEqualizerConfiguration >	createDisabled ()

static std::shared_ptr< InMemoryEqualizerConfiguration >	createDefault ()

Protected Member Functions
	InMemoryEqualizerConfiguration (int minBandLevel, int maxBandLevel, int defaultDelta, const std::set< acsdkEqualizerInterfaces::EqualizerBand > &bandsSupported, const std::set< acsdkEqualizerInterfaces::EqualizerMode > &modesSupported, acsdkEqualizerInterfaces::EqualizerState defaultState)

	InMemoryEqualizerConfiguration ()

bool	validateConfiguration ()

bool	validateBandLevelMap (const acsdkEqualizerInterfaces::EqualizerBandLevelMap &bandLevelMap, bool validateValues)

Detailed Description

In-memory implementation for the equalizer configuration. The configuration is set during the creation and is not changed afterwards. This class also holds the hardcoded defaults used by SDK.

Constructor & Destructor Documentation

◆ ~InMemoryEqualizerConfiguration()

alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::~InMemoryEqualizerConfiguration ( )

overridedefault

Destructor.

◆ InMemoryEqualizerConfiguration() [1/2]

alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::InMemoryEqualizerConfiguration	(	int	minBandLevel,
		int	maxBandLevel,
		int	defaultDelta,
		const std::set< acsdkEqualizerInterfaces::EqualizerBand > &	bandsSupported,
		const std::set< acsdkEqualizerInterfaces::EqualizerMode > &	modesSupported,
		acsdkEqualizerInterfaces::EqualizerState	defaultState
	)

protected

Constructor.

Parameters

minBandLevel	Minimum band level supported by the equalizer.
maxBandLevel	Maximum band level supported by the equalizer.
defaultDelta	Default delta value to adjust the equalizer.
bandsSupported	A set of bands supported by the equalizer.
modesSupported	A set of modes supported by the equalizer.
defaultState	Default state of the equalizer used when there is no state stored in a persistent storage or when a band level is being reset.

◆ InMemoryEqualizerConfiguration() [2/2]

alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::InMemoryEqualizerConfiguration ( )

protected

Constructor creating a disabled configuration.

Member Function Documentation

◆ create()

static std::shared_ptr<InMemoryEqualizerConfiguration> alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::create	(	int	minBandLevel,
		int	maxBandLevel,
		int	defaultDelta,
		const std::set< acsdkEqualizerInterfaces::EqualizerBand > &	bandsSupported,
		const std::set< acsdkEqualizerInterfaces::EqualizerMode > &	modesSupported,
		acsdkEqualizerInterfaces::EqualizerState	defaultState
	)

static

Factory to create an instance of InMemoryEqualizerConfiguration from the parameters provided.

Parameters

minBandLevel	Minimum band level supported by the equalizer.
maxBandLevel	Maximum band level supported by the equalizer.
defaultDelta	Default delta value to adjust the equalizer.
bandsSupported	A set of bands supported by the equalizer.
modesSupported	A set of modes supported by the equalizer.
defaultState	Default state of the equalizer used when there is no state stored in a persistent storage or when a band level is being reset.

Returns: An instance of InMemoryEqualizerConfiguration on success, or nullptr in case of invalid parameters or inconsistent configuration.

◆ createDefault()

static std::shared_ptr<InMemoryEqualizerConfiguration> alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::createDefault ( )

static

A factory to create an instance of InMemoryEqualizerConfiguration using the hardcoded defaults.

Returns: An instance of InMemoryEqualizerConfiguration using the hardcoded defaults.

◆ createDisabled()

static std::shared_ptr<InMemoryEqualizerConfiguration> alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::createDisabled ( )

static

Factory to create disabled version of the configuration.

Returns: An instance of disabled version of the configuration.

◆ getDefaultBandDelta()

int alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::getDefaultBandDelta ( ) const

overridevirtual

Returns the default value of band value changes.

Returns: The default value of band value changes.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ getDefaultState()

acsdkEqualizerInterfaces::EqualizerState alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::getDefaultState ( ) const

overridevirtual

Returns EqualizerState object defining default values for equalizer mode and band levels. These values should be used when resetting any band to its default level.

Returns: EqualizerState object representing the default state.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ getMaxBandLevel()

int alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::getMaxBandLevel ( ) const

overridevirtual

Returns the maximum band value supported by the device.

Returns: The maximum band value supported by the device.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ getMinBandLevel()

int alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::getMinBandLevel ( ) const

overridevirtual

Returns the minimum band value supported by the device.

Returns: The minimum band value supported by the device.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ getSupportedBands()

std::set<acsdkEqualizerInterfaces::EqualizerBand> alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::getSupportedBands ( ) const

overridevirtual

Returns a set of EQ bands supported by the device.

Returns: A set of EQ bands supported by the device.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ getSupportedModes()

std::set<acsdkEqualizerInterfaces::EqualizerMode> alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::getSupportedModes ( ) const

overridevirtual

Returns a set of EQ modes supported by the device.

Returns: A set of EQ modes supported by the device.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ isBandSupported()

bool alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::isBandSupported ( acsdkEqualizerInterfaces::EqualizerBand band ) const

overridevirtual

Checks if band is supported by the device.

Parameters

band	`EqualizerBand` to check.

Returns: True if band is supported, false otherwise.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ isEnabled()

bool alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::isEnabled ( ) const

overridevirtual

Returns true if equalizer is enabled, false otherwise.

Returns: True if equalizer is enabled, false otherwise.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ isModeSupported()

bool alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::isModeSupported ( acsdkEqualizerInterfaces::EqualizerMode mode ) const

overridevirtual

Checks if mode is supported by the device.

Parameters

mode	`EqualizerMode` to check.

Returns: True if mode is supported, false otherwise.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface.

◆ validateBandLevelMap()

bool alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::validateBandLevelMap	(	const acsdkEqualizerInterfaces::EqualizerBandLevelMap &	bandLevelMap,
		bool	validateValues
	)

protected

Validates EqualizerBandLevelMap for consistency.

Parameters

bandLevelMap	A `EqualizerBandLevelMap` to validate.
validateValues	A flag indicating whether to check band levels for the allowed range. This could be false for the case when allowed range is inconsistent and there is no point in validating against it.

Returns: True if all bands are supported and (optionally) band levels are withing the supported range, false otherwise.

◆ validateConfiguration()

bool alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration::validateConfiguration ( )

protected

Validates the initialized configuration for consistency.

Returns: True if configuration is consistent, false otherwise.

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

/workplace/avs-device-sdk/capabilities/Equalizer/acsdkEqualizerImplementations/include/acsdkEqualizerImplementations/InMemoryEqualizerConfiguration.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~InMemoryEqualizerConfiguration()

◆ InMemoryEqualizerConfiguration() [1/2]

◆ InMemoryEqualizerConfiguration() [2/2]

Member Function Documentation

◆ create()

◆ createDefault()

◆ createDisabled()

◆ getDefaultBandDelta()

◆ getDefaultState()

◆ getMaxBandLevel()

◆ getMinBandLevel()

◆ getSupportedBands()

◆ getSupportedModes()

◆ isBandSupported()

◆ isEnabled()

◆ isModeSupported()

◆ validateBandLevelMap()

◆ validateConfiguration()