PresentationOrchestratorStateTrackerInterface.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_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONORCHESTRATORSTATETRACKERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONORCHESTRATORSTATETRACKERINTERFACE_H_

#include <memory>
#include <string>
#include <vector>

#include "PresentationOrchestratorStateObserverInterface.h"
#include "PresentationOrchestratorWindowObserverInterface.h"

namespace alexaClientSDK {
namespace presentationOrchestratorInterfaces {

class PresentationOrchestratorStateTrackerInterface {
public:
    virtual ~PresentationOrchestratorStateTrackerInterface() = default;

    virtual void acquireWindow(
        const std::string& clientId,
        const std::string& windowId,
        PresentationMetadata metadata) = 0;

    virtual void updatePresentationMetadata(
        const std::string& clientId,
        const std::string& windowId,
        PresentationMetadata metadata) = 0;

    virtual void releaseWindow(const std::string& clientId, const std::string& windowId) = 0;

    virtual std::string getFocusedInterface() = 0;

    virtual std::string getFocusedWindowId() = 0;

    virtual void setWindows(const std::vector<PresentationOrchestratorWindowInstance>& windows) = 0;

    virtual bool addWindow(const PresentationOrchestratorWindowInstance& window) = 0;

    virtual void removeWindow(const std::string& windowId) = 0;

    virtual void updateWindow(const PresentationOrchestratorWindowInstance& window) = 0;

    virtual std::vector<PresentationOrchestratorWindowInfo> getWindowInformation() = 0;

    virtual void addWindowObserver(std::weak_ptr<PresentationOrchestratorWindowObserverInterface> observer) = 0;

    virtual void removeWindowObserver(std::weak_ptr<PresentationOrchestratorWindowObserverInterface> observer) = 0;

    virtual void addStateObserver(std::weak_ptr<PresentationOrchestratorStateObserverInterface> observer) = 0;

    virtual void removeStateObserver(std::weak_ptr<PresentationOrchestratorStateObserverInterface> observer) = 0;

    virtual void setDeviceInterface(std::string interfaceName) = 0;

    virtual void releaseDeviceInterface() = 0;
};
}  // namespace presentationOrchestratorInterfaces
}  // namespace alexaClientSDK
#endif  // ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONORCHESTRATORSTATETRACKERINTERFACE_H_