AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::capabilityAgents::aip::test::TestDialogUXStateObserver Class Reference

Class to monitor DialogUXStateAggregator for the THINKING state and automatically move it to IDLE. More...

Inheritance diagram for alexaClientSDK::capabilityAgents::aip::test::TestDialogUXStateObserver:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::capabilityAgents::aip::test::TestDialogUXStateObserver:
Collaboration graph
[legend]

Public Member Functions

 TestDialogUXStateObserver (std::shared_ptr< avsCommon::avs::DialogUXStateAggregator > aggregator)
 
void onDialogUXStateChanged (DialogUXState newState) override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
virtual ~DialogUXStateObserverInterface ()=default
 

Additional Inherited Members

- 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::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
static std::string stateToString (DialogUXState state)
 

Detailed Description

Class to monitor DialogUXStateAggregator for the THINKING state and automatically move it to IDLE.

Constructor & Destructor Documentation

◆ TestDialogUXStateObserver()

alexaClientSDK::capabilityAgents::aip::test::TestDialogUXStateObserver::TestDialogUXStateObserver ( std::shared_ptr< avsCommon::avs::DialogUXStateAggregator aggregator)

Constructor

Parameters
aggregatorThe DialogUXStateAggregator to move from THINKING to IDLE.

Member Function Documentation

◆ onDialogUXStateChanged()

void alexaClientSDK::capabilityAgents::aip::test::TestDialogUXStateObserver::onDialogUXStateChanged ( DialogUXState  newState)
overridevirtual

This function is called whenever the AVS UX dialog state of the system changes. This function will block processing of other state changes, so any implementation of this should return quickly.

Parameters
newStateThe new dialog specific AVS UX state.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface.


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

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