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

#include <KeyWordDetectorStateObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface:
Inheritance graph
[legend]

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

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.

Implemented in alexaClientSDK::kwd::test::testStateObserver, and alexaClientSDK::kwd::test::testStateObserver.


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

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