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

#include <EqualizerRuntimeSetup.h>

Inheritance diagram for alexaClientSDK::defaultClient::EqualizerRuntimeSetup:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::defaultClient::EqualizerRuntimeSetup:
Collaboration graph
[legend]

Public Member Functions

 EqualizerRuntimeSetup (bool isEnabled=true)
 
void setConfiguration (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface > configuration)
 
void setStorage (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface > storage)
 
void setModeController (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface > modeController)
 
EqualizerRuntimeSetupInterface functions
std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterfacegetConfiguration () override
 
std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterfacegetStorage () override
 
std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterfacegetModeController () override
 
bool addEqualizer (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface > equalizer) override
 
bool addEqualizerControllerListener (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener) override
 
std::list< std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface > > getAllEqualizers () override
 
std::list< std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > > getAllEqualizerControllerListeners () override
 
bool isEnabled () override
 
- Public Member Functions inherited from alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface
virtual ~EqualizerRuntimeSetupInterface ()=default
 

Static Public Member Functions

static std::shared_ptr< EqualizerRuntimeSetupInterfacecreateEqualizerRuntimeSetupInterface (const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface > &equalizerConfiguration, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface > &equalizerStorage, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface > &equalizerModeController)
 

Detailed Description

Class containing references to implementations for all equalizer related interfaces.

Constructor & Destructor Documentation

◆ EqualizerRuntimeSetup()

alexaClientSDK::defaultClient::EqualizerRuntimeSetup::EqualizerRuntimeSetup ( bool  isEnabled = true)

Constructor.

Parameters
isEnabledWhether equalizer is enabled; true by default.

Member Function Documentation

◆ addEqualizer()

bool alexaClientSDK::defaultClient::EqualizerRuntimeSetup::addEqualizer ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerInterface equalizer)
overridevirtual

Adds EqualizerInterface instance to be used by the SDK.

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

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ addEqualizerControllerListener()

bool alexaClientSDK::defaultClient::EqualizerRuntimeSetup::addEqualizerControllerListener ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface listener)
overridevirtual

Adds EqualizerControllerListenerInterface instance to be used by the SDK.

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

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ createEqualizerRuntimeSetupInterface()

std::shared_ptr< EqualizerRuntimeSetupInterface > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::createEqualizerRuntimeSetupInterface ( const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface > &  equalizerConfiguration,
const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface > &  equalizerStorage,
const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface > &  equalizerModeController 
)
static

Factory method to create an instance of EqualizerRuntimeSetupInterface.

Parameters
equalizerConfigurationEqualizer configuration instance.
equalizerStorageEqualizer storage instance.
equalizerModeControllerEqualizer mode controller instance.
Returns
An enabled EqualizerRuntimeSetup if equalizer is enabled in the configuration instance; otherwise, a disabled EqualizerRuntimeSetupInterface.

◆ getAllEqualizerControllerListeners()

std::list< std::shared_ptr< EqualizerControllerListenerInterface > > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getAllEqualizerControllerListeners ( )
overridevirtual

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.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ getAllEqualizers()

std::list< std::shared_ptr< EqualizerInterface > > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getAllEqualizers ( )
overridevirtual

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.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ getConfiguration()

std::shared_ptr< EqualizerConfigurationInterface > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getConfiguration ( )
overridevirtual

Returns equalizer configuration instance.

Returns
Equalizer configuration instance.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ getModeController()

std::shared_ptr< EqualizerModeControllerInterface > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getModeController ( )
overridevirtual

Returns equalizer mode controller instance.

Returns
Equalizer mode controller instance.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ getStorage()

std::shared_ptr< EqualizerStorageInterface > alexaClientSDK::defaultClient::EqualizerRuntimeSetup::getStorage ( )
overridevirtual

Returns equalizer state storage instance.

Returns
Equalizer state storage instance.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ isEnabled()

bool alexaClientSDK::defaultClient::EqualizerRuntimeSetup::isEnabled ( )
overridevirtual

Whether the equalizer is enabled.

Returns
Whether the equalizer is enabled.

Implements alexaClientSDK::acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface.

◆ setConfiguration()

void alexaClientSDK::defaultClient::EqualizerRuntimeSetup::setConfiguration ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface configuration)

Set equalizer configuration instance.

Parameters
configurationEqualizer configuration instance.

◆ setModeController()

void alexaClientSDK::defaultClient::EqualizerRuntimeSetup::setModeController ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerModeControllerInterface modeController)

Set equalizer mode controller instance.

Parameters
modeControllerEqualizer mode controller instance.

◆ setStorage()

void alexaClientSDK::defaultClient::EqualizerRuntimeSetup::setStorage ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface storage)

Set equalizer state storage instance.

Parameters
storageEqualizer state storage instance.

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

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