Inheritance diagram for alexaClientSDK::presentationOrchestratorInterfaces::VisualTimeoutManagerInterface:

Collaboration diagram for alexaClientSDK::presentationOrchestratorInterfaces::VisualTimeoutManagerInterface:

Public Types
using	VisualTimeoutCallback = std::function< void()>

using	VisualTimeoutId = unsigned int

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...

Public Member Functions
virtual	~VisualTimeoutManagerInterface ()=default

virtual VisualTimeoutId	requestTimeout (std::chrono::milliseconds delay, VisualTimeoutCallback timeoutCallback)=0

virtual bool	stopTimeout (VisualTimeoutId timeoutId)=0

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::GUIActivityEventObserverInterface
virtual	~GUIActivityEventObserverInterface ()=default

virtual void	onGUIActivityEventReceived (const std::string &source, const GUIActivityEvent &activityEvent)=0

Additional Inherited Members
Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
static std::string	stateToString (DialogUXState state)

Member Typedef Documentation

◆ VisualTimeoutCallback

virtual alexaClientSDK::presentationOrchestratorInterfaces::VisualTimeoutManagerInterface::~VisualTimeoutManagerInterface ( )

virtualdefault

virtual VisualTimeoutId alexaClientSDK::presentationOrchestratorInterfaces::VisualTimeoutManagerInterface::requestTimeout	(	std::chrono::milliseconds	delay,
		VisualTimeoutCallback	timeoutCallback
	)

pure virtual

Creates a timeout, replaces any existing timeout which was registered

Parameters

delay	The time which must elapse before the timeout is fired
timeoutCallback	The callback which will be fired upon the timeout expiring

virtual bool alexaClientSDK::presentationOrchestratorInterfaces::VisualTimeoutManagerInterface::stopTimeout ( VisualTimeoutId timeoutId )

pure virtual

Stops a running timeout

Parameters

timeoutId The identifier returned in the call to requestTimeout

Returns: true if the timeout was stopped, false if this timeoutId does not match the id generated by the last call to requestTimeout

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

/workplace/avs-device-sdk/shared/PresentationOrchestrator/PresentationOrchestratorInterfaces/include/acsdk/PresentationOrchestratorInterfaces/VisualTimeoutManagerInterface.h