EndpointCapabilitiesBuilder.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_ENDPOINTCAPABILITIESBUILDER_H_
#define ACSDK_SAMPLE_ENDPOINT_ENDPOINTCAPABILITIESBUILDER_H_

#include <list>
#include <memory>
#include <unordered_set>

#include <acsdk/Sample/Endpoint/EndpointFocusAdapter.h>
#include <AVSCommon/SDKInterfaces/CapabilityConfigurationInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointCapabilitiesBuilderInterface.h>

#include <acsdk/Sample/Endpoint/EndpointAlexaLauncherHandler.h>

#ifdef ALEXA_KEYPAD_CONTROLLER
#include <acsdk/Sample/Endpoint/EndpointAlexaKeypadControllerHandler.h>
#endif

#ifdef ALEXA_PLAYBACK_CONTROLLER
#include <acsdkAlexaPlaybackControllerInterfaces/AlexaPlaybackControllerObserverInterface.h>
#include <acsdk/Sample/Endpoint/EndpointAlexaPlaybackControllerHandler.h>
#endif

#ifdef ALEXA_SEEK_CONTROLLER
#include <acsdk/Sample/Endpoint/EndpointAlexaSeekControllerHandler.h>
#endif

#ifdef ALEXA_VIDEO_RECORDER
#include <acsdk/Sample/Endpoint/EndpointAlexaVideoRecorderHandler.h>
#endif

#ifdef ALEXA_CHANNEL_CONTROLLER
#include <acsdk/Sample/Endpoint/EndpointAlexaChannelControllerHandler.h>
#endif

#ifdef ALEXA_RECORD_CONTROLLER
#include <acsdk/Sample/Endpoint/EndpointAlexaRecordControllerHandler.h>
#endif

#ifdef ALEXA_REMOTE_VIDEO_PLAYER
#include <acsdk/Sample/Endpoint/EndpointAlexaRemoteVideoPlayerHandler.h>
#endif

namespace alexaClientSDK {
namespace sampleApplications {
namespace common {
class EndpointCapabilitiesBuilder
        : public alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface {
public:
    EndpointCapabilitiesBuilder(std::shared_ptr<EndpointFocusAdapter> focusAdapter = nullptr);

    std::pair<std::list<Capability>, std::list<std::shared_ptr<alexaClientSDK::avsCommon::utils::RequiresShutdown>>>
    buildCapabilities(
        const alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointIdentifier& endpointId,
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface>& contextManager,
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface>&
            responseSender,
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>&
            exceptionSender) override;

    std::shared_ptr<EndpointAlexaLauncherHandler> getAlexaLauncherHandler() const;

private:
    std::mutex m_buildCapabilitiesMutex;

    bool m_capabilitiesBuilt;

    std::shared_ptr<EndpointFocusAdapter> m_focusAdapter;

    std::shared_ptr<EndpointAlexaLauncherHandler> m_launcherHandler;

#ifdef ALEXA_KEYPAD_CONTROLLER
    std::shared_ptr<EndpointAlexaKeypadControllerHandler> m_keypadControllerHandler;
#endif

#ifdef ALEXA_PLAYBACK_CONTROLLER
    std::shared_ptr<EndpointAlexaPlaybackControllerHandler> m_playbackControllerHandler;
#endif

#ifdef ALEXA_SEEK_CONTROLLER
    std::shared_ptr<EndpointAlexaSeekControllerHandler> m_seekControllerHandler;
#endif

#ifdef ALEXA_VIDEO_RECORDER
    std::shared_ptr<EndpointAlexaVideoRecorderHandler> m_videoRecorderHandler;
#endif

#ifdef ALEXA_CHANNEL_CONTROLLER
    std::shared_ptr<EndpointAlexaChannelControllerHandler> m_channelControllerHandler;
#endif

#ifdef ALEXA_RECORD_CONTROLLER
    std::shared_ptr<EndpointAlexaRecordControllerHandler> m_recordControllerHandler;
#endif

#ifdef ALEXA_REMOTE_VIDEO_PLAYER
    std::shared_ptr<EndpointAlexaRemoteVideoPlayerHandler> m_remoteVideoPlayerHandler;
#endif
};

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

#endif  // ACSDK_SAMPLE_ENDPOINT_ENDPOINTCAPABILITIESBUILDER_H_