LiveViewControllerInterface.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_ALEXALIVEVIEWCONTROLLERINTERFACES_INCLUDE_ACSDK_ALEXALIVEVIEWCONTROLLERINTERFACES_LIVEVIEWCONTROLLERINTERFACE_H_
#define ALEXA_CLIENT_SDK_ALEXALIVEVIEWCONTROLLERINTERFACES_INCLUDE_ACSDK_ALEXALIVEVIEWCONTROLLERINTERFACES_LIVEVIEWCONTROLLERINTERFACE_H_

#include <memory>
#include <string>

#include "LiveViewControllerConfiguration.h"
#include "LiveViewControllerObserverInterface.h"
#include "LiveViewControllerTypes.h"

namespace alexaClientSDK {
namespace alexaLiveViewControllerInterfaces {

class LiveViewControllerInterface {
public:
    struct StartLiveViewRequest {
        std::string sessionId;

        Target target;

        Role role;

        Participants participants;

        ViewerExperience viewerExperience;
    };

    struct Response {
        enum class Type {
            SUCCESS,
            FAILED_BATTERY_TOO_LOW,
            FAILED_MEDIA_SOURCE_NOT_FOUND,
            FAILED_MEDIA_SOURCE_ASLEEP,
            FAILED_MEDIA_SOURCE_TURNED_OFF,
            FAILED_UNAUTHORIZED,
            FAILED_INTERNAL_ERROR
        };

        Type type;

        std::string errorMessage;

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

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

    virtual ~LiveViewControllerInterface() = default;

    virtual Response start(std::unique_ptr<StartLiveViewRequest> request) = 0;

    virtual Response stop() = 0;

    virtual Response setCameraState(CameraState cameraState) = 0;

    virtual Configuration getConfiguration() = 0;

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

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

}  // namespace alexaLiveViewControllerInterfaces
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ALEXALIVEVIEWCONTROLLERINTERFACES_INCLUDE_ACSDK_ALEXALIVEVIEWCONTROLLERINTERFACES_LIVEVIEWCONTROLLERINTERFACE_H_