alexaClientSDK::capabilityAgents::equalizer Namespace Reference

Classes
class	EqualizerCapabilityAgent

Functions
static std::string	buildEQStateJson (const EqualizerState &state)
bool	parseDirectivePayload (const std::string &payload, Document *document)

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...

Function Documentation

buildEQStateJson()

static std::string alexaClientSDK::capabilityAgents::equalizer::buildEQStateJson ( const EqualizerState &  state )

static

Builds a JSON string containing an Equalizer state.

Parameters

state

EqualizerState to be serialized to JSON.

Returns

JSON string with serialized Equalizer State.

parseDirectivePayload()

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

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

Parameters

	payload	JSON string to parse.
[out]	document	Pointer to a parsed document.

Returns

True if parsing was successful, false otherwise.

Variable Documentation

DIRECTIVE_ADJUSTBANDS

const NamespaceAndName alexaClientSDK::capabilityAgents::equalizer::DIRECTIVE_ADJUSTBANDS {NAMESPACE, "AdjustBands"}

static

The AdjustBands directive identifier.

DIRECTIVE_RESETBANDS

const NamespaceAndName alexaClientSDK::capabilityAgents::equalizer::DIRECTIVE_RESETBANDS {NAMESPACE, "ResetBands"}

static

The ResetBands directive identifier.

DIRECTIVE_SETBANDS

const NamespaceAndName alexaClientSDK::capabilityAgents::equalizer::DIRECTIVE_SETBANDS {NAMESPACE, "SetBands"}

static

The SetBands directive identifier.

DIRECTIVE_SETMODE

const NamespaceAndName alexaClientSDK::capabilityAgents::equalizer::DIRECTIVE_SETMODE {NAMESPACE, "SetMode"}

static

The SetMode directive identifier.

EQUALIZER_JSON_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::equalizer::EQUALIZER_JSON_INTERFACE_NAME = "EqualizerController"

static

Equalizer interface name.

EQUALIZER_JSON_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::equalizer::EQUALIZER_JSON_INTERFACE_TYPE = "AlexaInterface"

static

Equalizer capability constants Equalizer interface type

EQUALIZER_JSON_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::equalizer::EQUALIZER_JSON_INTERFACE_VERSION = "1.0"

static

Equalizer interface version.

EQUALIZER_STATE

const NamespaceAndName alexaClientSDK::capabilityAgents::equalizer::EQUALIZER_STATE {NAMESPACE, "EqualizerState"}

static

The EqualizerController state portion of the Context.

EVENT_EQUALIZERCHANGED

const NamespaceAndName alexaClientSDK::capabilityAgents::equalizer::EVENT_EQUALIZERCHANGED {NAMESPACE, "EqualizerChanged"}

static

The EqualizerChanged event identifier.

JSON_KEY_BANDS

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_BANDS[] = "bands"

static

Name for "bands" JSON branch.

JSON_KEY_LEVEL

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_LEVEL[] = "level"

static

Name for "level" JSON value.

JSON_KEY_LEVELDELTA

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_LEVELDELTA[] = "levelDelta"

static

Name for "levelDelta" JSON value.

JSON_KEY_LEVELDIRECTION

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_LEVELDIRECTION[] = "levelDirection"

static

Name for "levelDirection" JSON value.

JSON_KEY_MAXIMUM

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_MAXIMUM[] = "maximum"

static

Name for "maximum" JSON value.

JSON_KEY_MINIMUM

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_MINIMUM[] = "minimum"

static

Name for "minimum" JSON value.

JSON_KEY_MODE

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_MODE[] = "mode"

static

Name for "mode" JSON value.

JSON_KEY_MODES

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_MODES[] = "modes"

static

Name for "modes" JSON branch.

JSON_KEY_NAME

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_NAME[] = "name"

static

Name for "name" JSON value.

JSON_KEY_RANGE

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_RANGE[] = "range"

static

Name for "range" JSON branch.

JSON_KEY_SUPPORTED

constexpr char alexaClientSDK::capabilityAgents::equalizer::JSON_KEY_SUPPORTED[] = "supported"

static

Name for "supported" JSON branch.

LEVEL_DIRECTION_DOWN

constexpr char alexaClientSDK::capabilityAgents::equalizer::LEVEL_DIRECTION_DOWN[] = "DOWN"

static

String representing negative level adjustment.

LEVEL_DIRECTION_UP

constexpr char alexaClientSDK::capabilityAgents::equalizer::LEVEL_DIRECTION_UP[] = "UP"

static

String representing positive level adjustment.

NAMESPACE

const std::string alexaClientSDK::capabilityAgents::equalizer::NAMESPACE = "EqualizerController"

static

The EqualizerController interface namespace.

TAG

const std::string alexaClientSDK::capabilityAgents::equalizer::TAG {"EqualizerController"}

static

String to identify log entries originating from this file.