AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::sampleApp::SampleEqualizerModeController Class Reference

#include <SampleEqualizerModeController.h>

Inheritance diagram for alexaClientSDK::sampleApp::SampleEqualizerModeController:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApp::SampleEqualizerModeController:
Collaboration graph
[legend]

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::EqualizerModeControllerInterfacecreateEqualizerModeControllerInterface ()
 
static std::shared_ptr< SampleEqualizerModeControllercreate ()
 

Detailed Description

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

Member Function Documentation

◆ create()

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

Factory method.

Deprecated:
Returns
An instance of SampleEqualizerModeController.

◆ createEqualizerModeControllerInterface()

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
modeThe 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 files:

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0