alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerModeControllerInterface Class Reference

#include <EqualizerModeControllerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerModeControllerInterface:

Public Member Functions
virtual	~EqualizerModeControllerInterface ()=default
virtual bool	setEqualizerMode (EqualizerMode mode)=0

Detailed Description

Interface to handle equalizer modes. It is up to device manufacturer to implement the mode behavior. For example vendor may wish to apply:

• Equalizer preset
• Volume scaling
• Audio effects such as reverb or surround.

Constructor & Destructor Documentation

~EqualizerModeControllerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerModeControllerInterface::~EqualizerModeControllerInterface ( )

virtualdefault

Destructor.

Member Function Documentation

setEqualizerMode()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerModeControllerInterface::setEqualizerMode ( EqualizerMode  mode )

pure virtual

Changes the current equalizer mode. Equalizer state listeners will be notified only if this method returns true. It is safe to change equalizer band values from this function, but changing mode is not allowed.

Parameters

mode	The EqualizerMode to set.

Returns

True if mode has been successfully set, false otherwise.

Implemented in alexaClientSDK::sampleApp::SampleEqualizerModeController.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/Audio/EqualizerModeControllerInterface.h