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

A dialog specific UX state observer. More...

#include <DialogUXStateObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface:
Inheritance graph

Public Types

enum  DialogUXState {
  DialogUXState::IDLE, DialogUXState::LISTENING, DialogUXState::EXPECTING, DialogUXState::THINKING,
  DialogUXState::SPEAKING, DialogUXState::FINISHED
 The different dialog specific AVS UX states. More...

Public Member Functions

virtual ~DialogUXStateObserverInterface ()=default
virtual void onDialogUXStateChanged (DialogUXState newState)=0

Static Public Member Functions

static std::string stateToString (DialogUXState state)

Detailed Description

A dialog specific UX state observer.

Member Enumeration Documentation

◆ DialogUXState

The different dialog specific AVS UX states.


Alexa is idle and ready for an interaction.


Alexa is currently listening.


Alexa is currently expecting a response from the customer.


A customer request has been completed and no more input is accepted. In this state, Alexa is waiting for a response from AVS.


Alexa is responding to a request with speech.


Alexa has finished processing a SPEAK directive. In this state there are no notifications triggered. If the SPEAK directive is part of a speech burst UX moves back to the SPEAKING state. If it was the last SPEAK directive after timeout the UX state moves to the IDLE state.

Constructor & Destructor Documentation

◆ ~DialogUXStateObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface::~DialogUXStateObserverInterface ( )


Member Function Documentation

◆ onDialogUXStateChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface::onDialogUXStateChanged ( DialogUXState  newState)
pure virtual

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.

newStateThe new dialog specific AVS UX state.

Implemented in alexaClientSDK::capabilityAgents::aip::test::TestDialogUXStateObserver, alexaClientSDK::sampleApp::InteractionManager, alexaClientSDK::capabilityAgents::aip::AudioInputProcessor, alexaClientSDK::capabilityAgents::templateRuntime::TemplateRuntime, alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer, alexaClientSDK::diagnostics::DevicePropertyAggregator, and alexaClientSDK::avsCommon::test::TestObserver.

◆ stateToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface::stateToString ( DialogUXState  state)

This function converts the provided DialogUXState to a string.

stateThe DialogUXState to convert to a string.
The string conversion of state.

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

AlexaClientSDK 1.20.1 - Copyright 2016-2020, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0