alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerObserverInterface Class Reference

#include <ModeControllerObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerObserverInterface:

Classes
struct	ModeState

Public Member Functions
virtual	~ModeControllerObserverInterface ()=default
virtual void	onModeChanged (const ModeState &mode, AlexaStateChangeCauseType cause)=0

Detailed Description

This interface is used to observe changes to the mode property of an endpoint that are caused by the ModeControllerInteface.

Constructor & Destructor Documentation

~ModeControllerObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerObserverInterface::~ModeControllerObserverInterface ( )

virtualdefault

Destructor.

Member Function Documentation

onModeChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerObserverInterface::onModeChanged ( const ModeState &  mode, AlexaStateChangeCauseType  cause  )

pure virtual

Notifies the change in the mode of the endpoint.

Parameters

mode	The toggle state specified using Mode.
cause	The cause for this change specified using AlexaStateChangeCauseType.

Implemented in alexaClientSDK::capabilityAgents::modeController::ModeControllerCapabilityAgent.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/ModeController/ModeControllerObserverInterface.h