alexaClientSDK::acsdkInputController Namespace Reference

Namespaces
	test

Classes
class	InputControllerCapabilityAgent
struct	InputControllerFactoryInterfaces
	This structure contains the interfaces to interact with the InputController Capability Agent. More...

Functions
avsCommon::utils::Optional< InputControllerFactoryInterfaces >	create (const std::shared_ptr< acsdkInputControllerInterfaces::InputControllerHandlerInterface > &handler, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender)
static bool	checkInputs (const InputControllerCapabilityAgent::InputFriendlyNameConfigurations &inputConfigurations)
static std::shared_ptr< CapabilityConfiguration >	getInputControllerCapabilityConfiguration (const InputControllerCapabilityAgent::InputFriendlyNameConfigurations &inputConfigurations)

Variables
static const std::string	TAG {"InputController"}
	String to identify log entries originating from this file. More...
static const std::string	NAMESPACE = "Alexa.InputController"
	The namespace for this capability agent. More...
static const NamespaceAndName	SELECT_INPUT {NAMESPACE, "SelectInput"}
	The SelectInput directive signature. More...
static const std::string	ALEXA_INTERFACE_TYPE = "AlexaInterface"
static const std::string	INPUT_CONTROLLER_CAPABILITY_INTERFACE_NAME = "Alexa.InputController"
	Interface name. More...
static const std::string	INPUT_CONTROLLER_CAPABILITY_INTERFACE_VERSION = "3.0"
	Interface version. More...
static const std::string	CAPABILITY_CONFIGURATION_KEY {"configurations"}
	The configuration key. More...
static const std::string	INPUT_CONTROLLER_INPUT_KEY = "input"
	Payload input key. More...
static const std::string	INPUT_CONTROLLER_CONFIGURATION_KEY = "inputs"
	Payload inputs key. More...
static const std::string	INPUT_CONTROLLER_CONFIGURATION_NAME_KEY = "name"
	Payload name key. More...
static const std::string	INPUT_CONTROLLER_CONFIGURATION_FRIENDLY_NAMES_KEY = "friendlyNames"
	Payload friendlyNames key. More...

Function Documentation

checkInputs()

static bool alexaClientSDK::acsdkInputController::checkInputs ( const InputControllerCapabilityAgent::InputFriendlyNameConfigurations &  inputConfigurations )

static

A helper function to check if the input configurations from the handler is valid.

Parameters

inputConfigurations

The inputs and its friendly names.

Returns

true if valid, false otherwise.

create()

Optional< InputControllerFactoryInterfaces > alexaClientSDK::acsdkInputController::create	(	const std::shared_ptr< acsdkInputControllerInterfaces::InputControllerHandlerInterface > &	handler,
		const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &	exceptionSender
	)

Creates a new InputController capability agent

Parameters

handler	The handler for InputController input updates.
exceptionSender	The object to use for sending AVS Exception messages.

Returns

An Optional InputControllerFactoryInterfaces object.

getInputControllerCapabilityConfiguration()

static std::shared_ptr<CapabilityConfiguration> alexaClientSDK::acsdkInputController::getInputControllerCapabilityConfiguration ( const InputControllerCapabilityAgent::InputFriendlyNameConfigurations &  inputConfigurations )

static

A helper function to generate the CapabilityConfiguration based on the InputConfigurations.

Parameters

inputConfigurations

The InputConfigurations to read from.

Returns

A std::shared_ptr to a CapabilityConfiguration.

Variable Documentation

ALEXA_INTERFACE_TYPE

const std::string alexaClientSDK::acsdkInputController::ALEXA_INTERFACE_TYPE = "AlexaInterface"

static

InputController capability constants The AlexaInterface constant type.

CAPABILITY_CONFIGURATION_KEY

const std::string alexaClientSDK::acsdkInputController::CAPABILITY_CONFIGURATION_KEY {"configurations"}

static

The configuration key.

INPUT_CONTROLLER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::acsdkInputController::INPUT_CONTROLLER_CAPABILITY_INTERFACE_NAME = "Alexa.InputController"

static

Interface name.

INPUT_CONTROLLER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::acsdkInputController::INPUT_CONTROLLER_CAPABILITY_INTERFACE_VERSION = "3.0"

static

Interface version.

INPUT_CONTROLLER_CONFIGURATION_FRIENDLY_NAMES_KEY

const std::string alexaClientSDK::acsdkInputController::INPUT_CONTROLLER_CONFIGURATION_FRIENDLY_NAMES_KEY = "friendlyNames"

static

Payload friendlyNames key.

INPUT_CONTROLLER_CONFIGURATION_KEY

const std::string alexaClientSDK::acsdkInputController::INPUT_CONTROLLER_CONFIGURATION_KEY = "inputs"

static

Payload inputs key.

INPUT_CONTROLLER_CONFIGURATION_NAME_KEY

const std::string alexaClientSDK::acsdkInputController::INPUT_CONTROLLER_CONFIGURATION_NAME_KEY = "name"

static

Payload name key.

INPUT_CONTROLLER_INPUT_KEY

const std::string alexaClientSDK::acsdkInputController::INPUT_CONTROLLER_INPUT_KEY = "input"

static

Payload input key.

NAMESPACE

const std::string alexaClientSDK::acsdkInputController::NAMESPACE = "Alexa.InputController"

static

The namespace for this capability agent.

SELECT_INPUT

const NamespaceAndName alexaClientSDK::acsdkInputController::SELECT_INPUT {NAMESPACE, "SelectInput"}

static

The SelectInput directive signature.

TAG

const std::string alexaClientSDK::acsdkInputController::TAG {"InputController"}

static

String to identify log entries originating from this file.