MRMHandlerInterface.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_ACSDKMULTIROOMMUSIC_INCLUDE_ACSDKMULTIROOMMUSIC_MRMHANDLERINTERFACE_H_
#define ALEXA_CLIENT_SDK_ACSDKMULTIROOMMUSIC_INCLUDE_ACSDKMULTIROOMMUSIC_MRMHANDLERINTERFACE_H_

#include <memory>
#include <mutex>
#include <string>

#include <AVSCommon/AVS/AVSDirective.h>
#include <AVSCommon/SDKInterfaces/RenderPlayerInfoCardsProviderInterface.h>
#include <AVSCommon/SDKInterfaces/DialogUXStateObserverInterface.h>
#include <AVSCommon/SDKInterfaces/SpeakerManagerObserverInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>

namespace alexaClientSDK {
namespace capabilityAgents {
namespace mrm {

class MRMHandlerInterface
        : public avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
        , public avsCommon::utils::RequiresShutdown {
public:
    explicit MRMHandlerInterface(const std::string& shutdownName);

    virtual ~MRMHandlerInterface() override = default;

    virtual std::string getVersionString() const = 0;

    virtual bool handleDirective(
        const std::string& nameSpace,
        const std::string& name,
        const std::string& messageId,
        const std::string& payload) = 0;

    virtual void onUserInactivityReportSent() = 0;

    virtual void onCallStateChange(bool active) = 0;

    virtual void onDialogUXStateChanged(
        avsCommon::sdkInterfaces::DialogUXStateObserverInterface::DialogUXState newState) = 0;

    virtual void setObserver(
        std::shared_ptr<avsCommon::sdkInterfaces::RenderPlayerInfoCardsObserverInterface> observer) = 0;
};

inline MRMHandlerInterface::MRMHandlerInterface(const std::string& shutdownName) :
        avsCommon::utils::RequiresShutdown{shutdownName} {
}

}  // namespace mrm
}  // namespace capabilityAgents
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACSDKMULTIROOMMUSIC_INCLUDE_ACSDKMULTIROOMMUSIC_MRMHANDLERINTERFACE_H_