AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface Class Referenceabstract

#include <EqualizerRuntimeSetupInterface.h>

Inheritance diagram for alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~EqualizerRuntimeSetupInterface ()=default
 
virtual std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterfacegetConfiguration ()=0
 
virtual std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterfacegetStorage ()=0
 
virtual std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterfacegetModeController ()=0
 
virtual bool addEqualizer (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface > equalizer)=0
 
virtual bool addEqualizerControllerListener (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener)=0
 
virtual std::list< std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface > > getAllEqualizers ()=0
 
virtual std::list< std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > > getAllEqualizerControllerListeners ()=0
 
virtual bool isEnabled ()=0
 

Detailed Description

Interface for equalizer runtime setup.

Constructor & Destructor Documentation

◆ ~EqualizerRuntimeSetupInterface()

virtual alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::~EqualizerRuntimeSetupInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ addEqualizer()

virtual bool alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::addEqualizer ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface equalizer)
pure virtual

Adds EqualizerInterface instance to be used by the SDK.

Parameters
equalizerEqualizerInterface instance to be used by the SDK.
Returns
Whether the equalizer was added.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.

◆ addEqualizerControllerListener()

virtual bool alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::addEqualizerControllerListener ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface listener)
pure virtual

Adds EqualizerControllerListenerInterface instance to be used by the SDK.

Parameters
listenerEqualizerControllerListenerInterface instance to be used by the SDK.
Returns
Whether the listener was added.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.

◆ getAllEqualizerControllerListeners()

virtual std::list<std::shared_ptr<acsdkEqualizerInterfaces::EqualizerControllerListenerInterface> > alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::getAllEqualizerControllerListeners ( )
pure virtual

Returns a list of all equalizer controller listeners that are going to be used by the SDK.

Returns
List of all equalizer controller listeners that are going to be used by the SDK.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.

◆ getAllEqualizers()

virtual std::list<std::shared_ptr<acsdkEqualizerInterfaces::EqualizerInterface> > alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::getAllEqualizers ( )
pure virtual

Returns a list of all equalizers that are going to be used by the SDK.

Returns
List of all equalizers that are going to be used by the SDK.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.

◆ getConfiguration()

virtual std::shared_ptr<acsdkEqualizerInterfaces::EqualizerConfigurationInterface> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::getConfiguration ( )
pure virtual

Returns equalizer configuration instance.

Returns
Equalizer configuration instance.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.

◆ getModeController()

virtual std::shared_ptr<acsdkEqualizerInterfaces::EqualizerModeControllerInterface> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::getModeController ( )
pure virtual

Returns equalizer mode controller instance.

Returns
Equalizer mode controller instance.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.

◆ getStorage()

virtual std::shared_ptr<acsdkEqualizerInterfaces::EqualizerStorageInterface> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::getStorage ( )
pure virtual

Returns equalizer state storage instance.

Returns
Equalizer state storage instance.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.

◆ isEnabled()

virtual bool alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface::isEnabled ( )
pure virtual

Whether the equalizer is enabled.

Returns
Whether the equalizer is enabled.

Implemented in alexaClientSDK::defaultClient::EqualizerRuntimeSetup.


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

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