DevicePropertyAggregatorInterface.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_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_DEVICEPROPERTYAGGREGATORINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_DEVICEPROPERTYAGGREGATORINTERFACE_H_

#include <string>
#include <unordered_map>

#include <acsdkAlertsInterfaces/AlertObserverInterface.h>
#include <acsdkAudioPlayerInterfaces/AudioPlayerObserverInterface.h>
#include <acsdkNotificationsInterfaces/NotificationsObserverInterface.h>
#include <AVSCommon/SDKInterfaces/AuthObserverInterface.h>
#include <AVSCommon/SDKInterfaces/ConnectionStatusObserverInterface.h>
#include <AVSCommon/SDKInterfaces/ContextManagerInterface.h>
#include <AVSCommon/SDKInterfaces/DialogUXStateObserverInterface.h>
#include <AVSCommon/SDKInterfaces/PowerController/PowerControllerObserverInterface.h>
#include <AVSCommon/SDKInterfaces/RangeController/RangeControllerObserverInterface.h>
#include <AVSCommon/SDKInterfaces/SpeakerManagerInterface.h>
#include <AVSCommon/SDKInterfaces/SpeakerManagerObserverInterface.h>
#include <AVSCommon/Utils/Optional.h>
#include <Settings/DeviceSettingsManager.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {
namespace diagnostics {

class DevicePropertyAggregatorInterface
        : public acsdkAlertsInterfaces::AlertObserverInterface
        , public acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
        , public avsCommon::sdkInterfaces::AuthObserverInterface
        , public avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
        , public avsCommon::sdkInterfaces::ContextRequesterInterface
        , public acsdkNotificationsInterfaces::NotificationsObserverInterface
        , public avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
        , public avsCommon::sdkInterfaces::DialogUXStateObserverInterface
        , public avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface
        , public avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface {
public:
    static constexpr const char* DEVICE_CONTEXT = "DeviceContext";

    static constexpr const char* ALERT_TYPE_AND_STATE = "AlertTypeAndState";

    static constexpr const char* AUDIO_PLAYER_STATE = "AudioPlayerState";

    static constexpr const char* CONTENT_ID = "ContentId";

    static constexpr const char* CONNECTION_STATE = "ConnectionState";

    static constexpr const char* NOTIFICATION_INDICATOR = "NotificationIndicator";

    static constexpr const char* TTS_PLAYER_STATE = "TTSPlayerState";

    static constexpr const char* AVS_SPEAKER_VOLUME = "AVSSpeakerVolume";

    static constexpr const char* AVS_SPEAKER_MUTE = "AVSSpeakerMute";

    static constexpr const char* AVS_ALERTS_VOLUME = "AVSAlertsVolume";

    static constexpr const char* AVS_ALERTS_MUTE = "AVSAlertsMute";

    static constexpr const char* DO_NOT_DISTURB = "DoNotDisturb";

    static constexpr const char* LOCALE = "Locale";

    static constexpr const char* WAKE_WORDS = "WakeWords";

    static constexpr const char* REGISTRATION_STATUS = "RegistrationStatus";

    static constexpr const char* RANGE_CONTROLLER_STATUS = "RangeControllerStatus";

    static constexpr const char* POWER_CONTROLLER_STATUS = "PowerControllerStatus";

    virtual avsCommon::utils::Optional<std::string> getDeviceProperty(const std::string& propertyKey) = 0;

    virtual std::unordered_map<std::string, std::string> getAllDeviceProperties() = 0;

    virtual void setContextManager(
        std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager) = 0;

    virtual void setDeviceSettingsManager(std::shared_ptr<settings::DeviceSettingsManager> settingManager) = 0;
    virtual void initializeVolume(
        std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface> speakerManager) = 0;
};

}  // namespace diagnostics
}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_DEVICEPROPERTYAGGREGATORINTERFACE_H_