PlaybackCommand.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 ALEXA_CLIENT_SDK_CAPABILITYAGENTS_PLAYBACKCONTROLLER_INCLUDE_PLAYBACKCONTROLLER_PLAYBACKCOMMAND_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_PLAYBACKCONTROLLER_INCLUDE_PLAYBACKCONTROLLER_PLAYBACKCOMMAND_H_

#include <string>
#include <ostream>
#include <AVSCommon/AVS/PlaybackButtons.h>

namespace alexaClientSDK {
namespace capabilityAgents {
namespace playbackController {

class PlaybackCommand {
public:
    PlaybackCommand(const std::string& name);

    virtual ~PlaybackCommand() = default;

    virtual std::string getEventName() const = 0;

    virtual std::string getEventPayload() const = 0;

    friend std::ostream& operator<<(std::ostream&, const PlaybackCommand& command);

    static const PlaybackCommand& buttonToCommand(avsCommon::avs::PlaybackButton button);

    static const PlaybackCommand& toggleToCommand(avsCommon::avs::PlaybackToggle toggle, bool action);

protected:
    const std::string m_name;

private:
    virtual std::string toString() const;
};

class ButtonCommand_v1_0 : public PlaybackCommand {
public:
    ButtonCommand_v1_0(const std::string& name);

    std::string getEventName() const override;

    std::string getEventPayload() const override;
};

class ButtonCommand_v1_1 : public PlaybackCommand {
public:
    ButtonCommand_v1_1(const std::string& name);

    std::string getEventName() const override;

    std::string getEventPayload() const override;
};

class ToggleCommand : public PlaybackCommand {
public:
    ToggleCommand(const std::string& name, bool action);

    std::string getEventName() const override;

    std::string getEventPayload() const override;

private:
    std::string getActionString() const;

    std::string toString() const override;

    bool m_action;
};

}  // namespace playbackController
}  // namespace capabilityAgents
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_PLAYBACKCONTROLLER_INCLUDE_PLAYBACKCONTROLLER_PLAYBACKCOMMAND_H_