AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Attributes | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface Class Referenceabstract

#include <DevicePropertyAggregatorInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface:
Collaboration graph
[legend]

Public Member Functions

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
 
- Public Member Functions inherited from alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface
virtual ~AlertObserverInterface ()=default
 
virtual void onAlertStateChange (const AlertInfo &alertInfo)=0
 
- Public Member Functions inherited from alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
virtual ~AudioPlayerObserverInterface ()=default
 
virtual void onPlayerActivityChanged (avsCommon::avs::PlayerActivity state, const Context &context)=0
 
virtual void onSeekActivity (const SeekStatus seekStatus, const Context &context)
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface
virtual ~AuthObserverInterface ()=default
 
virtual void onAuthStateChange (State newState, Error error)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
virtual ~ConnectionStatusObserverInterface ()=default
 
virtual void onConnectionStatusChanged (const Status status, const ChangedReason reason)=0
 
virtual void onConnectionStatusChanged (const Status status, const std::vector< EngineConnectionStatus > &engineStatuses)
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface
virtual ~ContextRequesterInterface ()=default
 
virtual void onContextAvailable (const std::string &jsonContext)
 
virtual void onContextAvailable (const endpoints::EndpointIdentifier &endpointId, const avs::AVSContext &endpointContext, ContextRequestToken requestToken)
 
virtual void onContextFailure (const ContextRequestError error)
 
virtual void onContextFailure (const ContextRequestError error, ContextRequestToken token)
 
- Public Member Functions inherited from alexaClientSDK::acsdkNotificationsInterfaces::NotificationsObserverInterface
virtual ~NotificationsObserverInterface ()=default
 
virtual void onSetIndicator (avsCommon::avs::IndicatorState state)=0
 
virtual void onNotificationReceived ()=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
virtual void onSpeakerSettingsChanged (const Source &source, const ChannelVolumeInterface::Type &type, const SpeakerInterface::SpeakerSettings &settings)=0
 
virtual ~SpeakerManagerObserverInterface ()=default
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
virtual ~DialogUXStateObserverInterface ()=default
 
virtual void onDialogUXStateChanged (DialogUXState newState)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface
virtual ~RangeControllerObserverInterface ()=default
 
virtual void onRangeChanged (const RangeState &rangeState, AlexaStateChangeCauseType cause)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface
virtual ~PowerControllerObserverInterface ()=default
 
virtual void onPowerStateChanged (const PowerState &powerState, AlexaStateChangeCauseType cause)=0
 

Static Public Attributes

static constexpr const char * DEVICE_CONTEXT = "DeviceContext"
 Property Key to get Device Context. The Property Value is the json string containing the device context. More...
 
static constexpr const char * ALERT_TYPE_AND_STATE = "AlertTypeAndState"
 Property Key for Alerts state. The Property Value is a string of format "Alert:State". Ex: "ALARM:STARTED". More...
 
static constexpr const char * AUDIO_PLAYER_STATE = "AudioPlayerState"
 
static constexpr const char * CONTENT_ID = "ContentId"
 Property Key for Audio Player Content ID. The Property Value is a content ID string. More...
 
static constexpr const char * CONNECTION_STATE = "ConnectionState"
 Property Key for Connection State. The Property Value is a string representing connection state. Ex: "CONNECTED". More...
 
static constexpr const char * NOTIFICATION_INDICATOR = "NotificationIndicator"
 
static constexpr const char * TTS_PLAYER_STATE = "TTSPlayerState"
 Property Key for TTS Player State. The Property Value is a string representing the TTS state. Ex: "THINKING". More...
 
static constexpr const char * AVS_SPEAKER_VOLUME = "AVSSpeakerVolume"
 Property Key for AVS Speaker Volume. The Property Value is a string representing the speaker volume. Ex: "25". More...
 
static constexpr const char * AVS_SPEAKER_MUTE = "AVSSpeakerMute"
 
static constexpr const char * AVS_ALERTS_VOLUME = "AVSAlertsVolume"
 Property Key for AVS Alerts Volume. The Property Value is a string representing the alerts volume. Ex: "50". More...
 
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"
 
- Static Public Attributes inherited from alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface
static const int ORIGINAL_TIME_FIELD_MIN = 0
 The minimum value for the field in OriginalTime. More...
 
static const int ORIGINAL_TIME_HOUR_MAX = 23
 The maximum value for the hour field in OriginalTime. More...
 
static const int ORIGINAL_TIME_MINUTE_MAX = 59
 The maximum value for the minute field in OriginalTime. More...
 
static const int ORIGINAL_TIME_SECOND_MAX = 59
 The maximum value for the second field in OriginalTime. More...
 
static const int ORIGINAL_TIME_MILLISECOND_MAX = 999
 The maximum value for the millisecond field in OriginalTime. More...
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface
enum  State {
  State::READY, State::STARTED, State::STOPPED, State::SNOOZED,
  State::COMPLETED, State::PAST_DUE, State::FOCUS_ENTERED_FOREGROUND, State::FOCUS_ENTERED_BACKGROUND,
  State::ERROR, State::DELETED, State::SCHEDULED_FOR_LATER
}
 
enum  Type { Type::ALARM, Type::TIMER, Type::REMINDER }
 
- Public Types inherited from alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
enum  SeekStatus { SeekStatus::SEEK_START, SeekStatus::SEEK_COMPLETE }
 Enum representing Seek activities. More...
 
- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface
enum  State {
  State::UNINITIALIZED, State::REFRESHED, State::EXPIRED, State::UNRECOVERABLE_ERROR,
  State::AUTHORIZING
}
 The enum State describes the state of authorization. More...
 
enum  Error {
  Error::SUCCESS, Error::UNKNOWN_ERROR, Error::AUTHORIZATION_FAILED, Error::UNAUTHORIZED_CLIENT,
  Error::SERVER_ERROR, Error::INVALID_REQUEST, Error::INVALID_VALUE, Error::AUTHORIZATION_EXPIRED,
  Error::UNSUPPORTED_GRANT_TYPE, Error::INVALID_CODE_PAIR, Error::AUTHORIZATION_PENDING, Error::SLOW_DOWN,
  Error::INTERNAL_ERROR, Error::INVALID_CBL_CLIENT_ID
}
 The enum Error encodes possible errors which may occur when changing state. More...
 
- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
enum  Status { Status::DISCONNECTED, Status::PENDING, Status::CONNECTED }
 
enum  ChangedReason {
  ChangedReason::NONE, ChangedReason::SUCCESS, ChangedReason::UNRECOVERABLE_ERROR, ChangedReason::ACL_CLIENT_REQUEST,
  ChangedReason::ACL_DISABLED, ChangedReason::DNS_TIMEDOUT, ChangedReason::CONNECTION_TIMEDOUT, ChangedReason::CONNECTION_THROTTLED,
  ChangedReason::INVALID_AUTH, ChangedReason::PING_TIMEDOUT, ChangedReason::WRITE_TIMEDOUT, ChangedReason::READ_TIMEDOUT,
  ChangedReason::FAILURE_PROTOCOL_ERROR, ChangedReason::INTERNAL_ERROR, ChangedReason::SERVER_INTERNAL_ERROR, ChangedReason::SERVER_SIDE_DISCONNECT,
  ChangedReason::SERVER_ENDPOINT_CHANGED
}
 
- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
enum  Source { Source::DIRECTIVE, Source::LOCAL_API, Source::EXTERNAL_CLIENT }
 Indicates whether the source of the call is from an AVS Directive or through a Local API call. More...
 
- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
enum  DialogUXState {
  DialogUXState::IDLE, DialogUXState::LISTENING, DialogUXState::EXPECTING, DialogUXState::THINKING,
  DialogUXState::SPEAKING, DialogUXState::FINISHED
}
 The different dialog specific AVS UX states. More...
 
- Static Public Member Functions inherited from alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface
template<class T >
static bool withinBounds (T value, T minVal, T maxVal)
 
static std::string stateToString (State state)
 
static std::string typeToString (Type type)
 
static std::string originalTimeToString (const OriginalTime &originalTime)
 
- Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
static std::string stateToString (DialogUXState state)
 

Detailed Description

A class used to aggregate various states and properties of the device.

Member Function Documentation

◆ getAllDeviceProperties()

virtual std::unordered_map<std::string, std::string> alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::getAllDeviceProperties ( )
pure virtual

This method returns a list of all properties.

Returns
A map of all properties.

Implemented in alexaClientSDK::diagnostics::DevicePropertyAggregator.

◆ getDeviceProperty()

virtual avsCommon::utils::Optional<std::string> alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::getDeviceProperty ( const std::string &  propertyKey)
pure virtual

Gets the property for the given property key.

Parameters
propertyKeyThe property key string.
Returns
The property value as an Optional.

Implemented in alexaClientSDK::diagnostics::DevicePropertyAggregator.

◆ initializeVolume()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::initializeVolume ( std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface speakerManager)
pure virtual
Note
This API should only be used to initialize the volume values. Subsequent updates to volume values should come from the SpeakerManagerInterface.
Parameters
speakerManagerThe SpeakerManagerInterface to initialize volume values.

Implemented in alexaClientSDK::diagnostics::DevicePropertyAggregator.

◆ setContextManager()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::setContextManager ( std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface contextManager)
pure virtual

◆ setDeviceSettingsManager()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::setDeviceSettingsManager ( std::shared_ptr< settings::DeviceSettingsManager settingManager)
pure virtual

Set the DeviceSettingsManager

Parameters
settingManagerthe DeviceSettingsManager

Implemented in alexaClientSDK::diagnostics::DevicePropertyAggregator.

Member Data Documentation

◆ ALERT_TYPE_AND_STATE

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::ALERT_TYPE_AND_STATE = "AlertTypeAndState"
static

Property Key for Alerts state. The Property Value is a string of format "Alert:State". Ex: "ALARM:STARTED".

◆ AUDIO_PLAYER_STATE

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::AUDIO_PLAYER_STATE = "AudioPlayerState"
static

Property Key for Audio Player State. The Property Value is a string representing audio player state. Ex: "PLAYING"

◆ AVS_ALERTS_MUTE

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::AVS_ALERTS_MUTE = "AVSAlertsMute"
static

Property Key for AVS Alerts Mute. The Property Value is a string representing if the alerts is muted. Ex: "false".

◆ AVS_ALERTS_VOLUME

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::AVS_ALERTS_VOLUME = "AVSAlertsVolume"
static

Property Key for AVS Alerts Volume. The Property Value is a string representing the alerts volume. Ex: "50".

◆ AVS_SPEAKER_MUTE

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::AVS_SPEAKER_MUTE = "AVSSpeakerMute"
static

Property Key for AVS Speaker Mute. The Property Value is a string representing if the speaker is muted. Ex: "true"

◆ AVS_SPEAKER_VOLUME

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::AVS_SPEAKER_VOLUME = "AVSSpeakerVolume"
static

Property Key for AVS Speaker Volume. The Property Value is a string representing the speaker volume. Ex: "25".

◆ CONNECTION_STATE

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::CONNECTION_STATE = "ConnectionState"
static

Property Key for Connection State. The Property Value is a string representing connection state. Ex: "CONNECTED".

◆ CONTENT_ID

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::CONTENT_ID = "ContentId"
static

Property Key for Audio Player Content ID. The Property Value is a content ID string.

◆ DEVICE_CONTEXT

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::DEVICE_CONTEXT = "DeviceContext"
static

Property Key to get Device Context. The Property Value is the json string containing the device context.

◆ DO_NOT_DISTURB

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::DO_NOT_DISTURB = "DoNotDisturb"
static

Property Key for Do not Disturb. The Property Value is a string representing if do not disturb is on. Ex: "false".

◆ LOCALE

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::LOCALE = "Locale"
static

Property Key for Locale. The Property Value is a string representing the locale of the device. Ex: "[en-US]".

◆ NOTIFICATION_INDICATOR

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::NOTIFICATION_INDICATOR = "NotificationIndicator"
static

Property Key for Notification Indicator. The Property Value is a string representing notification state. Ex: "ON".

◆ POWER_CONTROLLER_STATUS

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::POWER_CONTROLLER_STATUS = "PowerControllerStatus"
static

Property Key for Power Controller status. The Property Value is a string representing if power status is ON. Ex: "true".

◆ RANGE_CONTROLLER_STATUS

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::RANGE_CONTROLLER_STATUS = "RangeControllerStatus"
static

Property Key for Range Controller status. The Property Value is a string representing the range value of an instance. Ex: Instance FanSpeed: "7".

◆ REGISTRATION_STATUS

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::REGISTRATION_STATUS = "RegistrationStatus"
static

Property Key for Registration status. The Property Value is a string representing the registration status. Ex: "true".

◆ TTS_PLAYER_STATE

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::TTS_PLAYER_STATE = "TTSPlayerState"
static

Property Key for TTS Player State. The Property Value is a string representing the TTS state. Ex: "THINKING".

◆ WAKE_WORDS

constexpr const char* alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface::WAKE_WORDS = "WakeWords"
static

Property Key for Wake Workds. The Property Value is a string representing the wake words configured on the device. Ex: "[ALEXA]"


The documentation for this class was generated from the following file:

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