alexaClientSDK::sampleApp::SampleEqualizerModeController Class Reference

#include <SampleEqualizerModeController.h>

Inheritance diagram for alexaClientSDK::sampleApp::SampleEqualizerModeController:

Collaboration diagram for alexaClientSDK::sampleApp::SampleEqualizerModeController:

Public Member Functions
EqualizerModeControllerInterface methods
bool	setEqualizerMode (acsdkEqualizerInterfaces::EqualizerMode mode) override
Public Member Functions inherited from alexaClientSDK::acsdkEqualizerInterfaces::EqualizerModeControllerInterface
virtual	~EqualizerModeControllerInterface ()=default

Static Public Member Functions
static std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface >	createEqualizerModeControllerInterface ()
static std::shared_ptr< SampleEqualizerModeController >	create ()

Detailed Description

Sample implementation of EqualizerModeControllerInterface that prints the mode requested to console.

Member Function Documentation

create()

static std::shared_ptr<SampleEqualizerModeController> alexaClientSDK::sampleApp::SampleEqualizerModeController::create ( )

static

Factory method.

Deprecated:

Returns

An instance of SampleEqualizerModeController.

createEqualizerModeControllerInterface()

static std::shared_ptr<acsdkEqualizerInterfaces::EqualizerModeControllerInterface> alexaClientSDK::sampleApp::SampleEqualizerModeController::createEqualizerModeControllerInterface ( )

static

Factory method to create an instance of EqualizerModeControllerInterface.

Returns

An instance of EqualizerModeControllerInterface.

setEqualizerMode()

bool alexaClientSDK::sampleApp::SampleEqualizerModeController::setEqualizerMode ( acsdkEqualizerInterfaces::EqualizerMode  mode )

overridevirtual

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.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerModeControllerInterface.

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/LibSampleApp/include/SampleApp/SampleEqualizerModeController.h