AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions | Variables
alexaClientSDK::acsdkEqualizer Namespace Reference

Namespaces

 test
 

Classes

class  EqualizerBandMapperInterface
 
class  EqualizerCapabilityAgent
 
class  EqualizerController
 
class  EqualizerLinearBandMapper
 
class  EqualizerUtils
 
class  InMemoryEqualizerConfiguration
 
class  MiscDBEqualizerStorage
 
class  SDKConfigEqualizerConfiguration
 

Functions

static std::string buildEQStateJson (const EqualizerState &state)
 
bool parseDirectivePayload (const std::string &payload, Document *document)
 
acsdkManufactory::Component< std::shared_ptr< acsdkEqualizerInterfaces::EqualizerStorageInterface >, std::shared_ptr< acsdkEqualizerInterfaces::EqualizerConfigurationInterface >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > > > getComponent ()
 
static const std::string EQUALIZER_CONFIG_KEY ("equalizer")
 JSON key for the root node value containing configuration values for Equalizer. More...
 

Variables

static const std::string TAG {"EqualizerController"}
 String to identify log entries originating from this file. More...
 
static const std::string NAMESPACE = "EqualizerController"
 The EqualizerController interface namespace. More...
 
static const NamespaceAndName EQUALIZER_STATE {NAMESPACE, "EqualizerState"}
 The EqualizerController state portion of the Context. More...
 
static const NamespaceAndName DIRECTIVE_SETBANDS {NAMESPACE, "SetBands"}
 The SetBands directive identifier. More...
 
static const NamespaceAndName DIRECTIVE_ADJUSTBANDS {NAMESPACE, "AdjustBands"}
 The AdjustBands directive identifier. More...
 
static const NamespaceAndName DIRECTIVE_RESETBANDS {NAMESPACE, "ResetBands"}
 The ResetBands directive identifier. More...
 
static const NamespaceAndName DIRECTIVE_SETMODE {NAMESPACE, "SetMode"}
 The SetMode directive identifier. More...
 
static const NamespaceAndName EVENT_EQUALIZERCHANGED {NAMESPACE, "EqualizerChanged"}
 The EqualizerChanged event identifier. More...
 
static const std::string EQUALIZER_JSON_INTERFACE_TYPE = "AlexaInterface"
 
static const std::string EQUALIZER_JSON_INTERFACE_NAME = "EqualizerController"
 Equalizer interface name. More...
 
static const std::string EQUALIZER_JSON_INTERFACE_VERSION = "1.0"
 Equalizer interface version. More...
 
static constexpr char JSON_KEY_BANDS [] = "bands"
 Name for "bands" JSON branch. More...
 
static constexpr char JSON_KEY_SUPPORTED [] = "supported"
 Name for "supported" JSON branch. More...
 
static constexpr char JSON_KEY_NAME [] = "name"
 Name for "name" JSON value. More...
 
static constexpr char JSON_KEY_LEVEL [] = "level"
 Name for "level" JSON value. More...
 
static constexpr char JSON_KEY_RANGE [] = "range"
 Name for "range" JSON branch. More...
 
static constexpr char JSON_KEY_MINIMUM [] = "minimum"
 Name for "minimum" JSON value. More...
 
static constexpr char JSON_KEY_MAXIMUM [] = "maximum"
 Name for "maximum" JSON value. More...
 
static constexpr char JSON_KEY_MODES [] = "modes"
 Name for "modes" JSON branch. More...
 
static constexpr char JSON_KEY_MODE [] = "mode"
 Name for "mode" JSON value. More...
 
static constexpr char JSON_KEY_LEVELDELTA [] = "levelDelta"
 Name for "levelDelta" JSON value. More...
 
static constexpr char JSON_KEY_LEVELDIRECTION [] = "levelDirection"
 Name for "levelDirection" JSON value. More...
 
static constexpr char LEVEL_DIRECTION_UP [] = "UP"
 String representing positive level adjustment. More...
 
static constexpr char LEVEL_DIRECTION_DOWN [] = "DOWN"
 String representing negative level adjustment. More...
 
static const std::string TAG {"EqualizerController"}
 String to identify log entries originating from this file. More...
 
static const std::string TAG {"EqualizerLinearBandMapper"}
 String to identify log entries originating from this file. More...
 
static const int MIN_TARGET_BANDS = 1
 Minimum number of target bands supported. More...
 
static const int MAX_TARGET_BANDS = 1000
 
static const std::string TAG {"EqualizerUtils"}
 String to identify log entries originating from this file. More...
 
static const std::string TAG {"InMemoryEqualizerConfiguration"}
 String to identify log entries originating from this file. More...
 
static constexpr int DEFAULT_LEVEL = 0
 Default level value. More...
 
static constexpr int DEFAULT_MIN_LEVEL = -6
 Default minimum band level in dB. -6 dB effectively halving the amplitude of the band. More...
 
static constexpr int DEFAULT_MAX_LEVEL = 6
 Default maximum band level in dB. +6 dB effectively doubling the amplitude of the band. More...
 
static constexpr int DEFAULT_ADJUST_DELTA = 1
 Adjustment value used by AVS by default, in dB, when you, for example, say "Alexa, raise the bass". More...
 
static const std::string TAG {"MiscDBEqualizerStorage"}
 String to identify log entries originating from this file. More...
 
static const std::string COMPONENT_NAME = "equalizerController"
 Component name needed for Misc DB. More...
 
static const std::string EQUALIZER_STATE_TABLE = "equalizerState"
 Misc DB table for equalizer state. More...
 
static const std::string EQUALIZER_STATE_KEY = "state"
 Key for equalizer state in Misc DB table. More...
 
static const std::string TAG {"SDKConfigEqualizerConfiguration"}
 String to identify log entries originating from this file. More...
 
static const std::string ENABLED_CONFIG_KEY = "enabled"
 JSON key for "enabled" value. More...
 
static const std::string BANDS_CONFIG_KEY = "bands"
 JSON key for "equalizer" branch. More...
 
static const std::string MODES_CONFIG_KEY = "modes"
 JSON key for "modes" branch. More...
 
static const std::string MODE_CONFIG_KEY = "mode"
 JSON key for "mode" value. More...
 
static const std::string DEFAULT_STATE_CONFIG_KEY = "defaultState"
 JSON key for "defaultState" branch. More...
 
static const std::string MIN_LEVEL_CONFIG_KEY = "minLevel"
 JSON key for "minLevel" value. More...
 
static const std::string MAX_LEVEL_CONFIG_KEY = "maxLevel"
 JSON key for "maxLevel" value. More...
 
static const std::string DEFAULT_DELTA_CONFIG_KEY = "defaultDelta"
 JSON key for "defaultDelta" value. More...
 

Function Documentation

◆ buildEQStateJson()

static std::string alexaClientSDK::acsdkEqualizer::buildEQStateJson ( const EqualizerState state)
static

Builds a JSON string containing an Equalizer state.

Parameters
stateEqualizerState to be serialized to JSON.
Returns
JSON string with serialized Equalizer State.

◆ EQUALIZER_CONFIG_KEY()

static const std::string alexaClientSDK::acsdkEqualizer::EQUALIZER_CONFIG_KEY ( "equalizer"  )
static

JSON key for the root node value containing configuration values for Equalizer.

◆ getComponent()

Creates an manufactory component that exports shared pointers to equalizer-related interfaces.

Returns
A component.

◆ parseDirectivePayload()

bool alexaClientSDK::acsdkEqualizer::parseDirectivePayload ( const std::string &  payload,
Document *  document 
)

Parses a directive payload JSON and returns a parsed document object.

Parameters
payloadJSON string to parse.
[out]documentPointer to a parsed document.
Returns
True if parsing was successful, false otherwise.

Variable Documentation

◆ BANDS_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::BANDS_CONFIG_KEY = "bands"
static

JSON key for "equalizer" branch.

◆ COMPONENT_NAME

const std::string alexaClientSDK::acsdkEqualizer::COMPONENT_NAME = "equalizerController"
static

Component name needed for Misc DB.

◆ DEFAULT_ADJUST_DELTA

constexpr int alexaClientSDK::acsdkEqualizer::DEFAULT_ADJUST_DELTA = 1
static

Adjustment value used by AVS by default, in dB, when you, for example, say "Alexa, raise the bass".

◆ DEFAULT_DELTA_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::DEFAULT_DELTA_CONFIG_KEY = "defaultDelta"
static

JSON key for "defaultDelta" value.

◆ DEFAULT_LEVEL

constexpr int alexaClientSDK::acsdkEqualizer::DEFAULT_LEVEL = 0
static

Default level value.

◆ DEFAULT_MAX_LEVEL

constexpr int alexaClientSDK::acsdkEqualizer::DEFAULT_MAX_LEVEL = 6
static

Default maximum band level in dB. +6 dB effectively doubling the amplitude of the band.

◆ DEFAULT_MIN_LEVEL

constexpr int alexaClientSDK::acsdkEqualizer::DEFAULT_MIN_LEVEL = -6
static

Default minimum band level in dB. -6 dB effectively halving the amplitude of the band.

◆ DEFAULT_STATE_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::DEFAULT_STATE_CONFIG_KEY = "defaultState"
static

JSON key for "defaultState" branch.

◆ DIRECTIVE_ADJUSTBANDS

const NamespaceAndName alexaClientSDK::acsdkEqualizer::DIRECTIVE_ADJUSTBANDS {NAMESPACE, "AdjustBands"}
static

The AdjustBands directive identifier.

◆ DIRECTIVE_RESETBANDS

const NamespaceAndName alexaClientSDK::acsdkEqualizer::DIRECTIVE_RESETBANDS {NAMESPACE, "ResetBands"}
static

The ResetBands directive identifier.

◆ DIRECTIVE_SETBANDS

const NamespaceAndName alexaClientSDK::acsdkEqualizer::DIRECTIVE_SETBANDS {NAMESPACE, "SetBands"}
static

The SetBands directive identifier.

◆ DIRECTIVE_SETMODE

const NamespaceAndName alexaClientSDK::acsdkEqualizer::DIRECTIVE_SETMODE {NAMESPACE, "SetMode"}
static

The SetMode directive identifier.

◆ ENABLED_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::ENABLED_CONFIG_KEY = "enabled"
static

JSON key for "enabled" value.

◆ EQUALIZER_JSON_INTERFACE_NAME

const std::string alexaClientSDK::acsdkEqualizer::EQUALIZER_JSON_INTERFACE_NAME = "EqualizerController"
static

Equalizer interface name.

◆ EQUALIZER_JSON_INTERFACE_TYPE

const std::string alexaClientSDK::acsdkEqualizer::EQUALIZER_JSON_INTERFACE_TYPE = "AlexaInterface"
static

Equalizer capability constants Equalizer interface type

◆ EQUALIZER_JSON_INTERFACE_VERSION

const std::string alexaClientSDK::acsdkEqualizer::EQUALIZER_JSON_INTERFACE_VERSION = "1.0"
static

Equalizer interface version.

◆ EQUALIZER_STATE

const NamespaceAndName alexaClientSDK::acsdkEqualizer::EQUALIZER_STATE {NAMESPACE, "EqualizerState"}
static

The EqualizerController state portion of the Context.

◆ EQUALIZER_STATE_KEY

const std::string alexaClientSDK::acsdkEqualizer::EQUALIZER_STATE_KEY = "state"
static

Key for equalizer state in Misc DB table.

◆ EQUALIZER_STATE_TABLE

const std::string alexaClientSDK::acsdkEqualizer::EQUALIZER_STATE_TABLE = "equalizerState"
static

Misc DB table for equalizer state.

◆ EVENT_EQUALIZERCHANGED

const NamespaceAndName alexaClientSDK::acsdkEqualizer::EVENT_EQUALIZERCHANGED {NAMESPACE, "EqualizerChanged"}
static

The EqualizerChanged event identifier.

◆ JSON_KEY_BANDS

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_BANDS = "bands"
static

Name for "bands" JSON branch.

◆ JSON_KEY_LEVEL

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_LEVEL = "level"
static

Name for "level" JSON value.

◆ JSON_KEY_LEVELDELTA

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_LEVELDELTA[] = "levelDelta"
static

Name for "levelDelta" JSON value.

◆ JSON_KEY_LEVELDIRECTION

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_LEVELDIRECTION[] = "levelDirection"
static

Name for "levelDirection" JSON value.

◆ JSON_KEY_MAXIMUM

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_MAXIMUM[] = "maximum"
static

Name for "maximum" JSON value.

◆ JSON_KEY_MINIMUM

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_MINIMUM[] = "minimum"
static

Name for "minimum" JSON value.

◆ JSON_KEY_MODE

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_MODE = "mode"
static

Name for "mode" JSON value.

◆ JSON_KEY_MODES

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_MODES[] = "modes"
static

Name for "modes" JSON branch.

◆ JSON_KEY_NAME

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_NAME[] = "name"
static

Name for "name" JSON value.

◆ JSON_KEY_RANGE

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_RANGE[] = "range"
static

Name for "range" JSON branch.

◆ JSON_KEY_SUPPORTED

constexpr char alexaClientSDK::acsdkEqualizer::JSON_KEY_SUPPORTED[] = "supported"
static

Name for "supported" JSON branch.

◆ LEVEL_DIRECTION_DOWN

constexpr char alexaClientSDK::acsdkEqualizer::LEVEL_DIRECTION_DOWN[] = "DOWN"
static

String representing negative level adjustment.

◆ LEVEL_DIRECTION_UP

constexpr char alexaClientSDK::acsdkEqualizer::LEVEL_DIRECTION_UP[] = "UP"
static

String representing positive level adjustment.

◆ MAX_LEVEL_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::MAX_LEVEL_CONFIG_KEY = "maxLevel"
static

JSON key for "maxLevel" value.

◆ MAX_TARGET_BANDS

const int alexaClientSDK::acsdkEqualizer::MAX_TARGET_BANDS = 1000
static

Maximum number of target bands supported. An unrealistic value is chosen to handle cases when huge number is provided by mistake.

◆ MIN_LEVEL_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::MIN_LEVEL_CONFIG_KEY = "minLevel"
static

JSON key for "minLevel" value.

◆ MIN_TARGET_BANDS

const int alexaClientSDK::acsdkEqualizer::MIN_TARGET_BANDS = 1
static

Minimum number of target bands supported.

◆ MODE_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::MODE_CONFIG_KEY = "mode"
static

JSON key for "mode" value.

◆ MODES_CONFIG_KEY

const std::string alexaClientSDK::acsdkEqualizer::MODES_CONFIG_KEY = "modes"
static

JSON key for "modes" branch.

◆ NAMESPACE

const std::string alexaClientSDK::acsdkEqualizer::NAMESPACE = "EqualizerController"
static

The EqualizerController interface namespace.

◆ TAG [1/7]

const std::string alexaClientSDK::acsdkEqualizer::TAG {"InMemoryEqualizerConfiguration"}
static

String to identify log entries originating from this file.

◆ TAG [2/7]

const std::string alexaClientSDK::acsdkEqualizer::TAG {"EqualizerLinearBandMapper"}
static

String to identify log entries originating from this file.

◆ TAG [3/7]

const std::string alexaClientSDK::acsdkEqualizer::TAG {"EqualizerController"}
static

String to identify log entries originating from this file.

◆ TAG [4/7]

const std::string alexaClientSDK::acsdkEqualizer::TAG {"EqualizerUtils"}
static

String to identify log entries originating from this file.

◆ TAG [5/7]

const std::string alexaClientSDK::acsdkEqualizer::TAG {"MiscDBEqualizerStorage"}
static

String to identify log entries originating from this file.

◆ TAG [6/7]

const std::string alexaClientSDK::acsdkEqualizer::TAG {"EqualizerController"}
static

String to identify log entries originating from this file.

◆ TAG [7/7]

const std::string alexaClientSDK::acsdkEqualizer::TAG {"SDKConfigEqualizerConfiguration"}
static

String to identify log entries originating from this 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