EndpointFocusAdapter.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_SAMPLE_ENDPOINT_ENDPOINTFOCUSADAPTER_H_
#define ACSDK_SAMPLE_ENDPOINT_ENDPOINTFOCUSADAPTER_H_

#include <functional>
#include <memory>
#include <string>

#include <acsdk/PresentationOrchestratorInterfaces/PresentationOrchestratorInterface.h>
#include <acsdk/PresentationOrchestratorInterfaces/PresentationOrchestratorStateTrackerInterface.h>
#include <AVSCommon/SDKInterfaces/ChannelObserverInterface.h>
#include <AVSCommon/SDKInterfaces/FocusManagerInterface.h>
#include <AVSCommon/Utils/Threading/Executor.h>

namespace alexaClientSDK {
namespace sampleApplications {
namespace common {

class EndpointFocusAdapter
        : public avsCommon::sdkInterfaces::ChannelObserverInterface
        , public std::enable_shared_from_this<EndpointFocusAdapter> {
public:
    using FocusAcquiredCallback = std::function<void(void)>;
    static std::shared_ptr<EndpointFocusAdapter> create(
        std::shared_ptr<avsCommon::sdkInterfaces::FocusManagerInterface> focusManager,
        std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorInterface> presentationOrchestrator,
        std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface>
            presentationOrchestratorStateTracker);

    virtual ~EndpointFocusAdapter() = default;

    void onFocusChanged(avsCommon::avs::FocusState focusState, avsCommon::avs::MixingBehavior behavior) override;

    void acquireFocus(const std::string& interfaceName, FocusAcquiredCallback callback);

private:
    EndpointFocusAdapter(
        std::shared_ptr<avsCommon::sdkInterfaces::FocusManagerInterface> focusManager,
        std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorInterface> presentationOrchestrator,
        std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface>
            presentationOrchestratorStateTracker);

    void executeAcquireContentChannel();

    void executeReleaseContentChannel();

    void executeAcquireWindow();

    void executeReleaseWindow();

    struct FocusAcquireInterfaceAndCallback {
        FocusAcquireInterfaceAndCallback(std::string interfaceName, FocusAcquiredCallback callback) :
                interfaceName{std::move(interfaceName)},
                callback(callback) {
        }

        std::string interfaceName;

        FocusAcquiredCallback callback;
    };

    using FocusAcquireInterfaceAndCallbackPtr = std::shared_ptr<FocusAcquireInterfaceAndCallback>;

    std::shared_ptr<avsCommon::sdkInterfaces::FocusManagerInterface> m_focusManager;

    std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorInterface> m_presentationOrchestrator;

    std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface>
        m_presentationOrchestratorStateTracker;

    FocusAcquireInterfaceAndCallbackPtr m_focusAcquirePtr;

    std::shared_ptr<avsCommon::utils::threading::Executor> m_executor;
};

}  // namespace common
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ACSDK_SAMPLE_ENDPOINT_ENDPOINTFOCUSADAPTER_H_