AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerObserverInterface Class Referenceabstract

#include <ModeControllerObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::modeController::ModeControllerObserverInterface:
Inheritance graph
[legend]

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
modeThe toggle state specified using Mode.
causeThe cause for this change specified using AlexaStateChangeCauseType.

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


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

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