AlexaPresentationFeatureClient.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 ACSDK_ALEXAPRESENTATIONFEATURECLIENT_ALEXAPRESENTATIONFEATURECLIENT_H_
#define ACSDK_ALEXAPRESENTATIONFEATURECLIENT_ALEXAPRESENTATIONFEATURECLIENT_H_

#include <memory>

#include <acsdk/AlexaPresentationInterfaces/AlexaPresentationCapabilityAgentInterface.h>
#include <acsdk/APLCapabilityCommonInterfaces/APLCapabilityAgentNotifierInterface.h>
#include <acsdk/APLCapabilityCommonInterfaces/APLCapabilityAgentObserverInterface.h>
#include <acsdk/APLCapabilityCommonInterfaces/VisualStateProviderInterface.h>
#include <acsdk/SDKClient/FeatureClientInterface.h>
#include <acsdk/SDKClient/SDKClientRegistry.h>
#include <acsdkShutdownManagerInterfaces/ShutdownManagerInterface.h>
#include <AVSCommon/SDKInterfaces/AVSConnectionManagerInterface.h>
#include <AVSCommon/SDKInterfaces/ContextManagerInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointBuilderInterface.h>
#include <AVSCommon/SDKInterfaces/ExceptionEncounteredSenderInterface.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>

namespace alexaClientSDK {
namespace featureClient {
class AlexaPresentationFeatureClient : public sdkClient::FeatureClientInterface {
public:
    static std::unique_ptr<AlexaPresentationFeatureClient> create(
        std::string aplVersion,
        std::shared_ptr<aplCapabilityCommonInterfaces::VisualStateProviderInterface> stateProviderInterface,
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>&
            exceptionSender,
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::AVSConnectionManagerInterface>&
            connectionManager,
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface>& contextManager,
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface>&
            endpointBuilder,
        const std::shared_ptr<alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder,
        const std::shared_ptr<sdkClient::SDKClientRegistry>& sdkClientRegistry);

    bool configure(const std::shared_ptr<alexaClientSDK::sdkClient::SDKClientRegistry>& sdkClientRegistry) override;
    void doShutdown() override;

    std::shared_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentInterface> getAPLCapabilityAgent() const;

    std::shared_ptr<alexaPresentationInterfaces::AlexaPresentationCapabilityAgentInterface>
    getAlexaPresentationCapabilityAgent() const;

    void addAPLCapabilityAgentObserver(
        std::weak_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface> observer);

    void removeAPLCapabilityAgentObserver(
        std::weak_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface> observer);

    ~AlexaPresentationFeatureClient();

private:
    AlexaPresentationFeatureClient(
        std::shared_ptr<alexaPresentationInterfaces::AlexaPresentationCapabilityAgentInterface> alexaPresentationCA,
        std::shared_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentInterface> aplCapabilityAgent,
        std::shared_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentNotifierInterface> aplCapabilityAgentNotifier,
        std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> shutdownManager);

    std::shared_ptr<alexaPresentationInterfaces::AlexaPresentationCapabilityAgentInterface> m_alexaPresentationCA;

    std::shared_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentInterface> m_aplCapabilityAgent;

    std::shared_ptr<aplCapabilityCommonInterfaces::APLCapabilityAgentNotifierInterface> m_aplCapabilityAgentNotifier;

    std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> m_shutdownManager;
};
}  // namespace featureClient
}  // namespace alexaClientSDK
#endif  // ACSDK_ALEXAPRESENTATIONFEATURECLIENT_ALEXAPRESENTATIONFEATURECLIENT_H_