AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <InputControllerCapabilityAgent.h>
Public Types | |
using | InputFriendlyNameConfigurations = acsdkInputControllerInterfaces::InputControllerHandlerInterface::InputFriendlyNameType |
Alias for brevity. More... | |
Static Public Member Functions | |
static std::shared_ptr< InputControllerCapabilityAgent > | create (const std::shared_ptr< acsdkInputControllerInterfaces::InputControllerHandlerInterface > &handler, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender) |
Additional Inherited Members | |
Protected Member Functions inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent | |
CapabilityAgent (const std::string &nameSpace, std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender) | |
virtual std::shared_ptr< DirectiveInfo > | createDirectiveInfo (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result) |
virtual void | preHandleDirective (std::shared_ptr< DirectiveInfo > info)=0 |
virtual void | handleDirective (std::shared_ptr< DirectiveInfo > info)=0 |
virtual void | cancelDirective (std::shared_ptr< DirectiveInfo > info)=0 |
void | removeDirective (const std::string &messageId) |
void | sendExceptionEncounteredAndReportFailed (std::shared_ptr< DirectiveInfo > info, const std::string &message, avsCommon::avs::ExceptionErrorType type=avsCommon::avs::ExceptionErrorType::INTERNAL_ERROR) |
const std::pair< std::string, std::string > | buildJsonEventString (const std::string &eventName, const std::string &dialogRequestIdString="", const std::string &payload="{}", const std::string &context="") const |
Protected Attributes inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent | |
const std::string | m_namespace |
The namespace of the capability agent. More... | |
std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > | m_exceptionEncounteredSender |
Object to use to send exceptionEncountered messages. More... | |
The Input Controller Capability Agent provides an implementation for a client to interface with the Alexa.InputController API.
AVS sends SelectInput directives to the device to switch the input.
using alexaClientSDK::acsdkInputController::InputControllerCapabilityAgent::InputFriendlyNameConfigurations = acsdkInputControllerInterfaces::InputControllerHandlerInterface::InputFriendlyNameType |
Alias for brevity.
|
virtualdefault |
Destructor.
|
override |
|
static |
Creates an instance of the InputControllerCapabilityAgent
.
handler | The handler for InputController input updates. |
exceptionSender | The object to use for sending AVS Exception messages. |
std::shared_ptr
to the new InputControllerCapabilityAgent
instance, a nullptr if failed.
|
overridevirtual |
Returns the configurations of the capability interfaces being implemented.
Implements alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface.
|
overridevirtual |
Returns the configuration of the directive handler.
The configuration consists of multiple directive routing rules and their respective blocking policy. The directives will be matched from the most specific rule (with all fields defined) to the least specific rule (which only matches the directive endpointId).
avs::DirectiveHandlerConfiguration
of the handler. Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.
|
override |
|
override |
|
override |
AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0