alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface Class Reference

#include <EqualizerConfigurationInterface.h>

Inheritance diagram for alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface:

Public Member Functions
virtual	~EqualizerConfigurationInterface ()=default
virtual bool	isEnabled () const =0
virtual std::set< EqualizerBand >	getSupportedBands () const =0
virtual std::set< EqualizerMode >	getSupportedModes () const =0
virtual int	getMinBandLevel () const =0
virtual int	getMaxBandLevel () const =0
virtual int	getDefaultBandDelta () const =0
virtual EqualizerState	getDefaultState () const =0
virtual bool	isBandSupported (EqualizerBand band) const =0
virtual bool	isModeSupported (EqualizerMode mode) const =0

Detailed Description

Interface to provide a configuration of equalizer capabilities supported by the device.

Constructor & Destructor Documentation

~EqualizerConfigurationInterface()

virtual alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::~EqualizerConfigurationInterface ( )

virtualdefault

Destructor.

Member Function Documentation

getDefaultBandDelta()

virtual int alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::getDefaultBandDelta ( ) const

pure virtual

Returns the default value of band value changes.

Returns

The default value of band value changes.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

getDefaultState()

virtual EqualizerState alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::getDefaultState ( ) const

pure virtual

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.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

getMaxBandLevel()

virtual int alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::getMaxBandLevel ( ) const

pure virtual

Returns the maximum band value supported by the device.

Returns

The maximum band value supported by the device.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

getMinBandLevel()

virtual int alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::getMinBandLevel ( ) const

pure virtual

Returns the minimum band value supported by the device.

Returns

The minimum band value supported by the device.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

getSupportedBands()

virtual std::set<EqualizerBand> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::getSupportedBands ( ) const

pure virtual

Returns a set of EQ bands supported by the device.

Returns

A set of EQ bands supported by the device.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

getSupportedModes()

virtual std::set<EqualizerMode> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::getSupportedModes ( ) const

pure virtual

Returns a set of EQ modes supported by the device.

Returns

A set of EQ modes supported by the device.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

isBandSupported()

virtual bool alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::isBandSupported ( EqualizerBand  band ) const

pure virtual

Checks if band is supported by the device.

Parameters

band	EqualizerBand to check.

Returns

True if band is supported, false otherwise.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

isEnabled()

virtual bool alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::isEnabled ( ) const

pure virtual

Returns true if equalizer is enabled, false otherwise.

Returns

True if equalizer is enabled, false otherwise.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

isModeSupported()

virtual bool alexaClientSDK::acsdkEqualizerInterfaces::EqualizerConfigurationInterface::isModeSupported ( EqualizerMode  mode ) const

pure virtual

Checks if mode is supported by the device.

Parameters

mode	EqualizerMode to check.

Returns

True if mode is supported, false otherwise.

Implemented in alexaClientSDK::acsdkEqualizer::InMemoryEqualizerConfiguration.

---

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

• /workplace/avs-device-sdk/capabilities/Equalizer/acsdkEqualizerInterfaces/include/acsdkEqualizerInterfaces/EqualizerConfigurationInterface.h