#include <KeyWordDetectorStateObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface:

Public Types
enum	KeyWordDetectorState { KeyWordDetectorState::ACTIVE, KeyWordDetectorState::STREAM_CLOSED, KeyWordDetectorState::ERROR }

Public Member Functions
virtual	~KeyWordDetectorStateObserverInterface ()=default

virtual void	onStateChanged (KeyWordDetectorState keyWordDetectorState)=0

Detailed Description

A KeyWordDetectorStateObserverInterface is an interface class that clients can extend to be notified of the state of the KeyWordDetector.

Member Enumeration Documentation

◆ KeyWordDetectorState

enum alexaClientSDK::avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface::KeyWordDetectorState

strong

An enum class used to specify the states that the KeyWordDetector can be in.

Enumerator
ACTIVE	Represents a healthy functioning KeyWordDetector.
STREAM_CLOSED	Represents when the stream that a KeyWordDetector is reading from has been closed.
ERROR	Represents an unknown error.

Constructor & Destructor Documentation

◆ ~KeyWordDetectorStateObserverInterface()

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

virtualdefault

Destructor.

Member Function Documentation

◆ onStateChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface::onStateChanged ( KeyWordDetectorState keyWordDetectorState )

pure virtual

Used to notify the observer of the KeyWordDetector of state changes and errors when reading from its stream in case the user needs to initialize a new stream.

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

/workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/KeyWordDetectorStateObserverInterface.h

Public Types