AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::integration::AipStateObserver Class Reference

#include <AipStateObserver.h>

Inheritance diagram for alexaClientSDK::integration::AipStateObserver:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::integration::AipStateObserver:
Collaboration graph
[legend]

Public Member Functions

 AipStateObserver ()
 
void onStateChanged (avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface::State newState) override
 
bool checkState (const avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface::State expectedState, const std::chrono::seconds duration=std::chrono::seconds(10))
 
avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface::State waitForNext (const std::chrono::seconds duration)
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface
virtual ~AudioInputProcessorObserverInterface ()=default
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface
enum  State { State::IDLE, State::EXPECTING_SPEECH, State::RECOGNIZING, State::BUSY }
 The different states the AudioInputProcessor can be in. More...
 
- Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface
static std::string stateToString (State state)
 

Constructor & Destructor Documentation

◆ AipStateObserver()

alexaClientSDK::integration::AipStateObserver::AipStateObserver ( )

Member Function Documentation

◆ checkState()

bool alexaClientSDK::integration::AipStateObserver::checkState ( const avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface::State  expectedState,
const std::chrono::seconds  duration = std::chrono::seconds(10) 
)

◆ onStateChanged()

void alexaClientSDK::integration::AipStateObserver::onStateChanged ( avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface::State  state)
overridevirtual

This function is called when the state of the observed AudioInputProcessor changes. This function will block processing of audio inputs, so implementations should return quickly.

Parameters
stateThe new state of the AudioInputProcessor.

Implements alexaClientSDK::avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface.

◆ waitForNext()

AudioInputProcessorObserverInterface::State alexaClientSDK::integration::AipStateObserver::waitForNext ( const std::chrono::seconds  duration)

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

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