AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerModeControllerInterface Class Referenceabstract

#include <EqualizerModeControllerInterface.h>

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

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:

Constructor & Destructor Documentation

◆ ~EqualizerModeControllerInterface()

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


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.

modeThe EqualizerMode to set.
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:

AlexaClientSDK 1.20.1 - Copyright 2016-2020, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0