AlexaSeekControllerInterface.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 ACSDKALEXASEEKCONTROLLERINTERFACES_ALEXASEEKCONTROLLERINTERFACE_H_
#define ACSDKALEXASEEKCONTROLLERINTERFACES_ALEXASEEKCONTROLLERINTERFACE_H_

#include <chrono>
#include <string>

namespace alexaClientSDK {
namespace acsdkAlexaSeekControllerInterfaces {

class AlexaSeekControllerInterface {
public:
    struct Response {
        enum class Type {
            SUCCESS,

            ALREADY_IN_OPERATION,

            CANCELED_BY_NEW_REQUEST,

            NO_CONTENT_AVAILABLE,

            CONTENT_CANNOT_BE_SEEKED,

            INTERNAL_ERROR
        };

        Response(std::chrono::milliseconds currentMediaPosition) :
                type{Type::SUCCESS},
                currentMediaPosition{currentMediaPosition} {};

        Response(Type type, const std::string& errorMessage) :
                type{type},
                currentMediaPosition{-1},
                errorMessage{errorMessage} {};

        Type type;

        std::chrono::milliseconds currentMediaPosition;

        std::string errorMessage;
    };

    virtual ~AlexaSeekControllerInterface() = default;

    virtual Response adjustSeekPosition(const std::chrono::milliseconds& deltaPosition) = 0;
};

}  // namespace acsdkAlexaSeekControllerInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKALEXASEEKCONTROLLERINTERFACES_ALEXASEEKCONTROLLERINTERFACE_H_