AlexaPlaybackControllerInterface.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 ACSDKALEXAPLAYBACKCONTROLLERINTERFACES_ALEXAPLAYBACKCONTROLLERINTERFACE_H_
#define ACSDKALEXAPLAYBACKCONTROLLERINTERFACES_ALEXAPLAYBACKCONTROLLERINTERFACE_H_

#include <string>

#include <AVSCommon/Utils/Optional.h>

#include "acsdkAlexaPlaybackControllerInterfaces/AlexaPlaybackControllerObserverInterface.h"
#include "acsdkAlexaPlaybackControllerInterfaces/PlaybackOperation.h"
#include "acsdkAlexaPlaybackControllerInterfaces/PlaybackState.h"

namespace alexaClientSDK {
namespace acsdkAlexaPlaybackControllerInterfaces {

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

            PLAYBACK_OPERATION_NOT_SUPPORTED,

            NO_CONTENT_AVAILABLE,

            NOT_SUPPORTED_IN_CURRENT_MODE,

            INTERNAL_ERROR
        };

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

        Response(Type responseType, const std::string& errorMessage) :
                responseType{responseType},
                errorMessage{errorMessage} {};

        Type responseType;

        std::string errorMessage;
    };

    virtual ~AlexaPlaybackControllerInterface() = default;

    virtual Response play() = 0;

    virtual Response pause() = 0;

    virtual Response stop() = 0;

    virtual Response startOver() = 0;

    virtual Response previous() = 0;

    virtual Response next() = 0;

    virtual Response rewind() = 0;

    virtual Response fastForward() = 0;

    virtual acsdkAlexaPlaybackControllerInterfaces::PlaybackState getPlaybackState() = 0;

    virtual std::set<acsdkAlexaPlaybackControllerInterfaces::PlaybackOperation> getSupportedOperations() = 0;

    virtual bool addObserver(const std::weak_ptr<AlexaPlaybackControllerObserverInterface>& observer) = 0;

    virtual void removeObserver(const std::weak_ptr<AlexaPlaybackControllerObserverInterface>& observer) = 0;
};

}  // namespace acsdkAlexaPlaybackControllerInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKALEXAPLAYBACKCONTROLLERINTERFACES_ALEXAPLAYBACKCONTROLLERINTERFACE_H_