AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
DevicePropertyAggregatorInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_DEVICEPROPERTYAGGREGATORINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_DEVICEPROPERTYAGGREGATORINTERFACE_H_
18 
19 #include <string>
20 #include <unordered_map>
21 
35 
36 namespace alexaClientSDK {
37 namespace avsCommon {
38 namespace sdkInterfaces {
39 namespace diagnostics {
40 
55 public:
57  static constexpr const char* DEVICE_CONTEXT = "DeviceContext";
58 
60  static constexpr const char* ALERT_TYPE_AND_STATE = "AlertTypeAndState";
61 
64  static constexpr const char* AUDIO_PLAYER_STATE = "AudioPlayerState";
65 
67  static constexpr const char* CONTENT_ID = "ContentId";
68 
70  static constexpr const char* CONNECTION_STATE = "ConnectionState";
71 
74  static constexpr const char* NOTIFICATION_INDICATOR = "NotificationIndicator";
75 
77  static constexpr const char* TTS_PLAYER_STATE = "TTSPlayerState";
78 
80  static constexpr const char* AVS_SPEAKER_VOLUME = "AVSSpeakerVolume";
81 
84  static constexpr const char* AVS_SPEAKER_MUTE = "AVSSpeakerMute";
85 
87  static constexpr const char* AVS_ALERTS_VOLUME = "AVSAlertsVolume";
88 
91  static constexpr const char* AVS_ALERTS_MUTE = "AVSAlertsMute";
92 
95  static constexpr const char* DO_NOT_DISTURB = "DoNotDisturb";
96 
99  static constexpr const char* LOCALE = "Locale";
100 
103  static constexpr const char* WAKE_WORDS = "WakeWords";
104 
107  static constexpr const char* REGISTRATION_STATUS = "RegistrationStatus";
108 
111  static constexpr const char* RANGE_CONTROLLER_STATUS = "RangeControllerStatus";
112 
115  static constexpr const char* POWER_CONTROLLER_STATUS = "PowerControllerStatus";
116 
123  virtual avsCommon::utils::Optional<std::string> getDeviceProperty(const std::string& propertyKey) = 0;
124 
130  virtual std::unordered_map<std::string, std::string> getAllDeviceProperties() = 0;
131 
137  virtual void setContextManager(
138  std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager) = 0;
139 
145  virtual void setDeviceSettingsManager(std::shared_ptr<settings::DeviceSettingsManager> settingManager) = 0;
152  virtual void initializeVolume(
153  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface> speakerManager) = 0;
154 };
155 
156 } // namespace diagnostics
157 } // namespace sdkInterfaces
158 } // namespace avsCommon
159 } // namespace alexaClientSDK
160 
161 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIAGNOSTICS_DEVICEPROPERTYAGGREGATORINTERFACE_H_
static constexpr const char * RANGE_CONTROLLER_STATUS
Definition: DevicePropertyAggregatorInterface.h:111
static constexpr const char * DEVICE_CONTEXT
Property Key to get Device Context. The Property Value is the json string containing the device conte...
Definition: DevicePropertyAggregatorInterface.h:57
static constexpr const char * AVS_SPEAKER_MUTE
Definition: DevicePropertyAggregatorInterface.h:84
static constexpr const char * REGISTRATION_STATUS
Definition: DevicePropertyAggregatorInterface.h:107
static constexpr const char * AVS_ALERTS_VOLUME
Property Key for AVS Alerts Volume. The Property Value is a string representing the alerts volume...
Definition: DevicePropertyAggregatorInterface.h:87
virtual void setDeviceSettingsManager(std::shared_ptr< settings::DeviceSettingsManager > settingManager)=0
static constexpr const char * ALERT_TYPE_AND_STATE
Property Key for Alerts state. The Property Value is a string of format "Alert:State". Ex: "ALARM:STARTED".
Definition: DevicePropertyAggregatorInterface.h:60
Definition: ConnectionStatusObserverInterface.h:31
static constexpr const char * CONNECTION_STATE
Property Key for Connection State. The Property Value is a string representing connection state...
Definition: DevicePropertyAggregatorInterface.h:70
static constexpr const char * AVS_SPEAKER_VOLUME
Property Key for AVS Speaker Volume. The Property Value is a string representing the speaker volume...
Definition: DevicePropertyAggregatorInterface.h:80
virtual void setContextManager(std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager)=0
static constexpr const char * TTS_PLAYER_STATE
Property Key for TTS Player State. The Property Value is a string representing the TTS state...
Definition: DevicePropertyAggregatorInterface.h:77
static constexpr const char * LOCALE
Definition: DevicePropertyAggregatorInterface.h:99
static constexpr const char * DO_NOT_DISTURB
Definition: DevicePropertyAggregatorInterface.h:95
static constexpr const char * AVS_ALERTS_MUTE
Definition: DevicePropertyAggregatorInterface.h:91
static constexpr const char * POWER_CONTROLLER_STATUS
Definition: DevicePropertyAggregatorInterface.h:115
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
virtual std::unordered_map< std::string, std::string > getAllDeviceProperties()=0
static constexpr const char * NOTIFICATION_INDICATOR
Definition: DevicePropertyAggregatorInterface.h:74
static constexpr const char * WAKE_WORDS
Definition: DevicePropertyAggregatorInterface.h:103
virtual void initializeVolume(std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > speakerManager)=0
static constexpr const char * AUDIO_PLAYER_STATE
Definition: DevicePropertyAggregatorInterface.h:64
virtual avsCommon::utils::Optional< std::string > getDeviceProperty(const std::string &propertyKey)=0
static constexpr const char * CONTENT_ID
Property Key for Audio Player Content ID. The Property Value is a content ID string.
Definition: DevicePropertyAggregatorInterface.h:67
A dialog specific UX state observer.
Definition: DialogUXStateObserverInterface.h:29

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0