alexaClientSDK::alexaInputControllerInterfaces Namespace Reference

Classes
class	InputControllerInterface
class	InputControllerObserverInterface

Enumerations
enum	Input {   Input::AUX_1, Input::AUX_2, Input::AUX_3, Input::AUX_4,   Input::AUX_5, Input::AUX_6, Input::AUX_7, Input::BLURAY,   Input::CABLE, Input::CD, Input::COAX_1, Input::COAX_2,   Input::COMPOSITE_1, Input::DVD, Input::GAME, Input::HD_RADIO,   Input::HDMI_1, Input::HDMI_2, Input::HDMI_3, Input::HDMI_4,   Input::HDMI_5, Input::HDMI_6, Input::HDMI_7, Input::HDMI_8,   Input::HDMI_9, Input::HDMI_10, Input::HDMI_ARC, Input::INPUT_1,   Input::INPUT_2, Input::INPUT_3, Input::INPUT_4, Input::INPUT_5,   Input::INPUT_6, Input::INPUT_7, Input::INPUT_8, Input::INPUT_9,   Input::INPUT_10, Input::IPOD, Input::LINE_1, Input::LINE_2,   Input::LINE_3, Input::LINE_4, Input::LINE_5, Input::LINE_6,   Input::LINE_7, Input::MEDIA_PLAYER, Input::OPTICAL_1, Input::OPTICAL_2,   Input::PHONO, Input::PLAYSTATION, Input::PLAYSTATION_3, Input::PLAYSTATION_4,   Input::SATELLITE, Input::SMARTCAST, Input::TUNER, Input::TV,   Input::USB_DAC, Input::VIDEO_1, Input::VIDEO_2, Input::VIDEO_3,   Input::XBOX }

Functions
std::string	inputToString (Input input)
avsCommon::utils::Optional< Input >	stringToInput (const std::string &inputString)

Enumeration Type Documentation

Input

enum alexaClientSDK::alexaInputControllerInterfaces::Input

strong

Enumerator
AUX_1	Auxiliary Input 1.
AUX_2	Auxiliary Input 2.
AUX_3	Auxiliary Input 3.
AUX_4	Auxiliary Input 4.
AUX_5	Auxiliary Input 5.
AUX_6	Auxiliary Input 6.
AUX_7	Auxiliary Input 7.
BLURAY	BluRay Input.
CABLE	Cable Input.
CD	CD Input.
COAX_1	COAX Input 1.
COAX_2	COAX Input 2.
COMPOSITE_1	Composite Input 1.
DVD	DVD Input.
GAME	Game Input.
HD_RADIO	High Definition Radio Input.
HDMI_1	HDMI Input 1.
HDMI_2	HDMI Input 2.
HDMI_3	HDMI Input 3.
HDMI_4	HDMI Input 4.
HDMI_5	HDMI Input 5.
HDMI_6	HDMI Input 6.
HDMI_7	HDMI Input 7.
HDMI_8	HDMI Input 8.
HDMI_9	HDMI Input 9.
HDMI_10	HDMI Input 10.
HDMI_ARC	HDMI Audio Relay Channel Input.
INPUT_1	Input 1.
INPUT_2	Input 2.
INPUT_3	Input 3.
INPUT_4	Input 4.
INPUT_5	Input 5.
INPUT_6	Input 6.
INPUT_7	Input 7.
INPUT_8	Input 8.
INPUT_9	Input 9.
INPUT_10	Input 10.
IPOD	IPod Input.
LINE_1	Line Input 1.
LINE_2	Line Input 2.
LINE_3	Line Input 3.
LINE_4	Line Input 4.
LINE_5	Line Input 5.
LINE_6	Line Input 6.
LINE_7	Line Input 7.
MEDIA_PLAYER	Media Player Input.
OPTICAL_1	Optical Input 1.
OPTICAL_2	Optical Input 2.
PHONO	Phono Input.
PLAYSTATION	PlayStation Input.
PLAYSTATION_3	PlayStation 3 Input.
PLAYSTATION_4	PlayStation 4 Input.
SATELLITE	Satellite Input.
SMARTCAST	SmartCast Input.
TUNER	Tuner Input.
TV	Television Input.
USB_DAC	USB Digital to Analog Converter Input.
VIDEO_1	Video Input 1.
VIDEO_2	Video Input 2.
VIDEO_3	Video Input 3.
XBOX	XBox Input.

Function Documentation

inputToString()

std::string alexaClientSDK::alexaInputControllerInterfaces::inputToString

(

Input

input

)

Convert an Input enum to its corresponding string value. Note that any input that does not map to Input enum value will return an empty string.

Parameters

input

The Input value to convert.

Returns

The corresponding string value for input. Returns an empty string if input does not map to a Input enum.

stringToInput()

avsCommon::utils::Optional<Input> alexaClientSDK::alexaInputControllerInterfaces::stringToInput

(

const std::string &

inputString

)

Convert a string to a corresponding Input enum value. Note that any inputString that does not map to Input enum value will return an Optional object with no value.

Parameters

inputString

The input string to convert.

Returns

An Optional object, with the value as the corresponding Input enum value for inputString if there is a match. Otherwise, return an Optional object with no value.