AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <PeripheralEndpointRangeControllerHandler.h>
Static Public Member Functions | |
static std::shared_ptr< PeripheralEndpointRangeControllerHandler > | create (const std::string &endpointName, const std::string &instance) |
Additional Inherited Members | |
Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerInterface | |
using | RangeState = avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::RangeState |
Alias to improve readability. More... | |
An implementation of an RangeControllerInterface
.
|
override |
|
overridevirtual |
Adjust the range of an instance.
deltaRange | The desired delta range of the instance. |
cause | The cause type for this action represented using AlexaStateChangeCauseType . |
AlexaResponseType
and string. For the successful operation, the controller should return a pair with AlexaResponseType::SUCCESS
with an empty string, otherwise returns a pair with the appropriate reason from AlexaResponseType
and a description of the error. Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerInterface.
|
static |
Create a PeripheralEndpointRangeControllerHandler object.
endpointName | The name of the endpoint. |
instance | The instance name of the capability. |
nullptr
.
|
overridevirtual |
Gets the controller configuration as defined in RangeControllerConfiguration
RangeControllerConfiguration
Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerInterface.
|
overridevirtual |
Gets the current range state of the instance.
AlexaResponseType::SUCCESS
and RangeState
otherwise returns a pair with the appropriate reason from AlexaResponseType
and a empty RangeState
. Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerInterface.
|
override |
|
overridevirtual |
Set the range of the instance.
range | The desired range value of the instance. |
cause | The cause type for this action represented using AlexaStateChangeCauseType . |
AlexaResponseType
and string. For the successful operation, the controller should return a pair with AlexaResponseType::SUCCESS
with an empty string, otherwise returns a pair with the appropriate reason from AlexaResponseType
and a description of the error. Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerInterface.
void alexaClientSDK::sampleApplications::common::PeripheralEndpointRangeControllerHandler::setRangeValue | ( | double | value | ) |
Set the range of the controller.
value | Range value to be set. |
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0