VideoRecorderInterface.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_ACSDKALEXAVIDEORECORDERINTERFACES_INCLUDE_ACSDKALEXAVIDEORECORDERINTERFACES_VIDEORECORDERINTERFACE_H_
#define ALEXA_CLIENT_SDK_ACSDKALEXAVIDEORECORDERINTERFACES_INCLUDE_ACSDKALEXAVIDEORECORDERINTERFACES_VIDEORECORDERINTERFACE_H_

#include <memory>
#include <string>

#include "VideoRecorderTypes.h"

namespace alexaClientSDK {
namespace acsdkAlexaVideoRecorderInterfaces {

class VideoRecorderInterface {
public:
    struct Response {
        enum class Type {
            SUCCESS,
            FAILED_TOO_MANY_FAILED_ATTEMPTS,
            FAILED_ACTION_NOT_PERMITTED_FOR_CONTENT,
            FAILED_CONFIRMATION_REQUIRED,
            FAILED_CONTENT_NOT_RECORDABLE,
            FAILED_NOT_SUBSCRIBED,
            FAILED_RECORDING_EXISTS,
            FAILED_STORAGE_FULL,
            FAILED_VIDEO_TITLE_DISAMBIGUATION_REQUIRED,
            FAILED_RECORDING_SCHEDULE_CONFLICT
        };

        Type type;

        std::string message;

        /*
         * Default Constructor, sets response type to success.
         */
        Response() : type(Type::SUCCESS) {
        }
    };

    virtual ~VideoRecorderInterface() = default;

    virtual Response searchAndRecord(std::unique_ptr<VideoRecorderRequest> request) = 0;

    virtual Response cancelRecording(std::unique_ptr<VideoRecorderRequest> request) = 0;

    virtual Response deleteRecording(std::unique_ptr<VideoRecorderRequest> request) = 0;

    virtual bool isExtendedRecordingGUIShown() = 0;

    virtual int getStorageUsedPercentage() = 0;
};
}  // namespace acsdkAlexaVideoRecorderInterfaces
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACSDKALEXAVIDEORECORDERINTERFACES_INCLUDE_ACSDKALEXAVIDEORECORDERINTERFACES_VIDEORECORDERINTERFACE_H_