![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <UserInactivityMonitorInterface.h>
Public Member Functions | |
virtual | ~UserInactivityMonitorInterface ()=default |
Destructor. More... | |
virtual void | onUserActive ()=0 |
The function to be called when the user has become active. More... | |
virtual std::chrono::seconds | timeSinceUserActivity ()=0 |
virtual void | addObserver (std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorObserverInterface > observer)=0 |
virtual void | removeObserver (std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorObserverInterface > observer)=0 |
This interface is used to notify an implementation of the user activity. Any component that interacts with the user (e.g. AudioInputProcessor) should register an instance of this interface to signal when user interaction is detected (e.g. SpeechStarted).
This interface should also send the System.UserInactivityReport Event as defined here: https://developer.amazon.com/docs/alexa/alexa-voice-service/system.html#userinactivityreport and notify its observers when this occurs.
|
virtualdefault |
Destructor.
|
pure virtual |
Adds an observer to be notified when the System.UserInactivityReport Event has been sent.
observer | The observer to be notified when the System.UserInactivityReport Event has been sent. |
|
pure virtual |
The function to be called when the user has become active.
Implemented in alexaClientSDK::capabilityAgents::system::UserInactivityMonitor.
|
pure virtual |
Removes an observer from the collection of observers which will be notified when the System.UserInactivityReport Event has been sent.
observer | The observer that should no longer be notified when the System.UserInactivityReport Event has been sent. |
|
pure virtual |
Calculates how many seconds have elapsed since a user last interacted with the device.
Implemented in alexaClientSDK::capabilityAgents::system::UserInactivityMonitor.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0