AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <InputControllerHandlerInterface.h>
Classes | |
struct | InputConfigurations |
The configuration of the inputs on the device. More... | |
Public Types | |
using | InputFriendlyNameType = std::unordered_map< std::string, std::unordered_set< std::string > > |
Public Member Functions | |
virtual | ~InputControllerHandlerInterface ()=default |
virtual InputConfigurations | getConfiguration ()=0 |
virtual bool | onInputChange (const std::string &input)=0 |
An interface to handle input changes from InputController.
using alexaClientSDK::acsdkInputControllerInterfaces::InputControllerHandlerInterface::InputFriendlyNameType = std::unordered_map<std::string, std::unordered_set<std::string> > |
Alias to a type used for defining the inputs. The key of the map is the input, and the set is the friendlyNames associated with the input. For more information, please refer to the Alexa.InputController API.
|
virtualdefault |
Destructor.
|
pure virtual |
A function to get the input configuration of the device.
InputConfigurations
of the device. Implemented in alexaClientSDK::acsdkInputController::test::MockHandler, and alexaClientSDK::sampleApp::InputControllerHandler.
|
pure virtual |
A callback function to request the change of the input on the device. The InputController
does not remember the previous input, so this callback will be called whenever AVS notifies a change in input. Also, during initialization, the application is responsible for remembering the previous input, as the InputController
does not notify the application of the previous input with this callback.
input | The selected input on the product. The input is guaranteed to be one of the inputs as specified in the InputConfigurations from getConfiguration() . |
Implemented in alexaClientSDK::acsdkInputController::test::MockHandler, and alexaClientSDK::sampleApp::InputControllerHandler.
AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0