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

Namespaces

 test
 

Classes

class  EqualizerConfigurationInterface
 
class  EqualizerControllerListenerInterface
 
class  EqualizerInterface
 
class  EqualizerModeControllerInterface
 
class  EqualizerRuntimeSetupInterface
 
struct  EqualizerState
 
class  EqualizerStorageInterface
 

Typedefs

using EqualizerBandLevelMap = std::unordered_map< EqualizerBand, int, avsCommon::utils::functional::EnumClassHash >
 A collection of bands with their level values. This is an alias for EqualizerBand to band level (int) map. More...
 

Enumerations

enum  EqualizerBand { EqualizerBand::BASS, EqualizerBand::MIDRANGE, EqualizerBand::TREBLE }
 
enum  EqualizerMode {
  EqualizerMode::NONE, EqualizerMode::MOVIE, EqualizerMode::MUSIC, EqualizerMode::NIGHT,
  EqualizerMode::SPORT, EqualizerMode::TV
}
 

Functions

bool operator== (const EqualizerState &state1, const EqualizerState &state2)
 
std::string equalizerBandToString (EqualizerBand band)
 
std::ostream & operator<< (std::ostream &stream, EqualizerBand band)
 
std::string equalizerModeToString (EqualizerMode mode)
 
std::ostream & operator<< (std::ostream &stream, EqualizerMode mode)
 
avsCommon::utils::error::SuccessResult< EqualizerBandstringToEqualizerBand (const std::string &stringValue)
 
avsCommon::utils::error::SuccessResult< EqualizerModestringToEqualizerMode (const std::string &stringValue)
 

Variables

const std::array< EqualizerBand, 3 > EqualizerBandValues
 
const std::array< EqualizerMode, 6 > EqualizerModeValues
 

Typedef Documentation

◆ EqualizerBandLevelMap

A collection of bands with their level values. This is an alias for EqualizerBand to band level (int) map.

Enumeration Type Documentation

◆ EqualizerBand

Enum representing all the equalizer bands supported by SDK. Customer device may support only a subset of these.

Enumerator
BASS 

Bass equalizer band.

MIDRANGE 

Mid-range equalizer band.

TREBLE 

Treble equalizer band.

◆ EqualizerMode

Enum representing all the equalizer modes supported by SDK. Customer device may support only a subset of these. 'NONE' represents a special mode to reflect custom band values with no named preset.

Enumerator
NONE 

Equalizer mode representing default (no mode) behavior.

MOVIE 

Movie equalizer mode.

MUSIC 

Music equalizer mode.

NIGHT 

Night equalizer mode.

SPORT 

Sport equalizer mode.

TV 

TV equalizer mode.

Function Documentation

◆ equalizerBandToString()

std::string alexaClientSDK::acsdkEqualizerInterfaces::equalizerBandToString ( EqualizerBand  band)
inline

Provides a string representation for EqualizerBand value.

Parameters
bandEqualizerBand to convert.
Returns
A string representation for EqualizerBand value.

◆ equalizerModeToString()

std::string alexaClientSDK::acsdkEqualizerInterfaces::equalizerModeToString ( EqualizerMode  mode)
inline

Provides a string representation for EqualizerMode value.

Parameters
modeEqualizerMode to convert.
Returns
A string representation for EqualizerMode value.

◆ operator<<() [1/2]

std::ostream& alexaClientSDK::acsdkEqualizerInterfaces::operator<< ( std::ostream &  stream,
EqualizerBand  band 
)
inline

Write a EqualizerBand value to an ostream as a string.

Parameters
streamThe stream to write the value to.
bandThe EqualizerBand value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [2/2]

std::ostream& alexaClientSDK::acsdkEqualizerInterfaces::operator<< ( std::ostream &  stream,
EqualizerMode  mode 
)
inline

Write a EqualizerMode value to an ostream as a string.

Parameters
streamThe stream to write the value to.
modeThe EqualizerMode value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator==()

bool alexaClientSDK::acsdkEqualizerInterfaces::operator== ( const EqualizerState state1,
const EqualizerState state2 
)
inline

◆ stringToEqualizerBand()

avsCommon::utils::error::SuccessResult<EqualizerBand> alexaClientSDK::acsdkEqualizerInterfaces::stringToEqualizerBand ( const std::string &  stringValue)
inline

Parses a string to EqualizerBand value.

Parameters
stringValuea string containing the value to parse.
Returns
SuccessResult describing the result of the operation

◆ stringToEqualizerMode()

avsCommon::utils::error::SuccessResult<EqualizerMode> alexaClientSDK::acsdkEqualizerInterfaces::stringToEqualizerMode ( const std::string &  stringValue)
inline

Parses a string to EqualizerMode value.

Parameters
stringValuea string containing the value to parse.
[out]modePointer to EqualizerMode to receive parsed result. If function fails, the value is not changed.
Returns
true if parsing was successful, false otherwise.

Variable Documentation

◆ EqualizerBandValues

const std::array<EqualizerBand, 3> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerBandValues
Initial value:
= {
{EqualizerBand::BASS, EqualizerBand::MIDRANGE, EqualizerBand::TREBLE}}

An iterable array that contains all the values of EqualizerBand in order from lower frequencies to higher.

◆ EqualizerModeValues

const std::array<EqualizerMode, 6> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerModeValues
Initial value:
EqualizerMode::MOVIE,
EqualizerMode::MUSIC,
EqualizerMode::NIGHT,
EqualizerMode::SPORT,
EqualizerMode::TV}}
static const std::string NONE
String to identify NONE property value.
Definition: DevicePropertyAggregator.cpp:37

An iterable array that contains all the values of EqualizerMode

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