InputControllerInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ACSDK_ALEXAINPUTCONTROLLERINTERFACES_INPUTCONTROLLERINTERFACE_H_
#define ACSDK_ALEXAINPUTCONTROLLERINTERFACES_INPUTCONTROLLERINTERFACE_H_

#include <string>
#include <unordered_set>
#include <vector>

#include "InputControllerObserverInterface.h"
#include "InputType.h"

namespace alexaClientSDK {
namespace alexaInputControllerInterfaces {

class InputControllerInterface {
public:
    struct Response {
        enum class Type {
            SUCCESS,
            FAILED_INVALID_VALUE,
            FAILED_TOO_MANY_FAILED_ATTEMPTS,
            FAILED_ENDPOINT_UNREACHABLE,
            FAILED_INTERNAL_ERROR
        };

        Response() : type{Type::SUCCESS} {};

        Response(Type type, std::string errorMessage) : type{type}, errorMessage{std::move(errorMessage)} {};

        Type type;

        std::string errorMessage;
    };

    virtual ~InputControllerInterface() = default;

    using SupportedInputs = std::vector<std::pair<Input, std::unordered_set<std::string>>>;

    /*
     * Return the inputs supported.
     *
     * @return the set of inputs the device supports.
     */
    virtual SupportedInputs getSupportedInputs() = 0;

    virtual Response setInput(Input input) = 0;

    virtual Input getInput() = 0;

    virtual bool addObserver(std::weak_ptr<InputControllerObserverInterface> observer) = 0;

    virtual void removeObserver(std::weak_ptr<InputControllerObserverInterface> observer) = 0;
};

}  // namespace alexaInputControllerInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDK_ALEXAINPUTCONTROLLERINTERFACES_INPUTCONTROLLERINTERFACE_H_