alexaClientSDK::equalizer::SDKConfigEqualizerConfiguration Class Reference

#include <SDKConfigEqualizerConfiguration.h>

Inheritance diagram for alexaClientSDK::equalizer::SDKConfigEqualizerConfiguration:

Collaboration diagram for alexaClientSDK::equalizer::SDKConfigEqualizerConfiguration:

Static Public Member Functions
static std::shared_ptr< SDKConfigEqualizerConfiguration >	create (avsCommon::utils::configuration::ConfigurationNode &configRoot)
Static Public Member Functions inherited from alexaClientSDK::equalizer::InMemoryEqualizerConfiguration
static std::shared_ptr< InMemoryEqualizerConfiguration >	create (int minBandLevel, int maxBandLevel, int defaultDelta, const std::set< avsCommon::sdkInterfaces::audio::EqualizerBand > &bandsSupported, const std::set< avsCommon::sdkInterfaces::audio::EqualizerMode > &modesSupported, avsCommon::sdkInterfaces::audio::EqualizerState defaultState)
static std::shared_ptr< InMemoryEqualizerConfiguration >	createDisabled ()
static std::shared_ptr< InMemoryEqualizerConfiguration >	createDefault ()

Static Public Attributes
static const bool	BAND_IS_SUPPORTED_IF_MISSING_IN_CONFIG = false
static const bool	MODE_IS_SUPPORTED_IF_MISSING_IN_CONFIG = false

Additional Inherited Members
Public Member Functions inherited from alexaClientSDK::equalizer::InMemoryEqualizerConfiguration
	~InMemoryEqualizerConfiguration () override=default
bool	isEnabled () const override
std::set< avsCommon::sdkInterfaces::audio::EqualizerBand >	getSupportedBands () const override
std::set< avsCommon::sdkInterfaces::audio::EqualizerMode >	getSupportedModes () const override
int	getMinBandLevel () const override
int	getMaxBandLevel () const override
int	getDefaultBandDelta () const override
avsCommon::sdkInterfaces::audio::EqualizerState	getDefaultState () const override
bool	isBandSupported (avsCommon::sdkInterfaces::audio::EqualizerBand band) const override
bool	isModeSupported (avsCommon::sdkInterfaces::audio::EqualizerMode mode) const override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerConfigurationInterface
virtual	~EqualizerConfigurationInterface ()=default
Protected Member Functions inherited from alexaClientSDK::equalizer::InMemoryEqualizerConfiguration
	InMemoryEqualizerConfiguration (int minBandLevel, int maxBandLevel, int defaultDelta, const std::set< avsCommon::sdkInterfaces::audio::EqualizerBand > &bandsSupported, const std::set< avsCommon::sdkInterfaces::audio::EqualizerMode > &modesSupported, avsCommon::sdkInterfaces::audio::EqualizerState defaultState)
	InMemoryEqualizerConfiguration ()
bool	validateConfiguration ()
bool	validateBandLevelMap (const avsCommon::sdkInterfaces::audio::EqualizerBandLevelMap &bandLevelMap, bool validateValues)

Detailed Description

An implementation of EqualizerConfigurationInterface that uses SDK configuration to initialize.

Member Function Documentation

create()

std::shared_ptr< SDKConfigEqualizerConfiguration > alexaClientSDK::equalizer::SDKConfigEqualizerConfiguration::create ( avsCommon::utils::configuration::ConfigurationNode &  configRoot )

static

Factory method to create an instance of SDKConfigEqualizerConfiguration.

Parameters

configRoot

ConfigurationNode containing the equalizer capabilities.

Returns

A new instance of SDKConfigEqualizerConfiguration on success or nullptr in case of failure.

Member Data Documentation

BAND_IS_SUPPORTED_IF_MISSING_IN_CONFIG

const bool alexaClientSDK::equalizer::SDKConfigEqualizerConfiguration::BAND_IS_SUPPORTED_IF_MISSING_IN_CONFIG = false

static

Options controlling different aspects of SDK configuration interpretation. Flag indicating whether we should treat a band as supported by default if "bands" configuration branch exists in JSON configuration.

MODE_IS_SUPPORTED_IF_MISSING_IN_CONFIG

const bool alexaClientSDK::equalizer::SDKConfigEqualizerConfiguration::MODE_IS_SUPPORTED_IF_MISSING_IN_CONFIG = false

static

Flag indicating whether we should treat a mode as supported by default if "modes" configuration branch exists in JSON configuration.

---

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

• /workplace/avs-device-sdk/EqualizerImplementations/include/EqualizerImplementations/SDKConfigEqualizerConfiguration.h
• /workplace/avs-device-sdk/EqualizerImplementations/src/SDKConfigEqualizerConfiguration.cpp