AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::kwd::test::MockKeyWordDetector Class Reference
Inheritance diagram for alexaClientSDK::kwd::test::MockKeyWordDetector:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::kwd::test::MockKeyWordDetector:
Collaboration graph
[legend]

Public Member Functions

void sendKeyWordCallToObservers ()
 
void sendStateChangeCallObservers (avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface::KeyWordDetectorState state)
 
- Public Member Functions inherited from alexaClientSDK::kwd::AbstractKeywordDetector
void addKeyWordObserver (std::shared_ptr< avsCommon::sdkInterfaces::KeyWordObserverInterface > keyWordObserver)
 
void removeKeyWordObserver (std::shared_ptr< avsCommon::sdkInterfaces::KeyWordObserverInterface > keyWordObserver)
 
void addKeyWordDetectorStateObserver (std::shared_ptr< avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface > keyWordDetectorStateObserver)
 
void removeKeyWordDetectorStateObserver (std::shared_ptr< avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface > keyWordDetectorStateObserver)
 
virtual ~AbstractKeywordDetector ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from alexaClientSDK::kwd::AbstractKeywordDetector
 AbstractKeywordDetector (std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::KeyWordObserverInterface >> keyWordObservers=std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::KeyWordObserverInterface >>(), std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface >> keyWordDetectorStateObservers=std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface >>())
 
void notifyKeyWordObservers (std::shared_ptr< avsCommon::avs::AudioInputStream > stream, std::string keyword, avsCommon::avs::AudioInputStream::Index beginIndex, avsCommon::avs::AudioInputStream::Index endIndex, std::shared_ptr< const std::vector< char >> KWDMetadata=nullptr) const
 
void notifyKeyWordDetectorStateObservers (avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface::KeyWordDetectorState state)
 
ssize_t readFromStream (std::shared_ptr< avsCommon::avs::AudioInputStream::Reader > reader, std::shared_ptr< avsCommon::avs::AudioInputStream > stream, void *buf, size_t nWords, std::chrono::milliseconds timeout, bool *errorOccurred)
 
- Static Protected Member Functions inherited from alexaClientSDK::kwd::AbstractKeywordDetector
static bool isByteswappingRequired (avsCommon::utils::AudioFormat audioFormat)
 

Detailed Description

A mock Keyword Detector that inherits from KeyWordDetector.

Member Function Documentation

◆ sendKeyWordCallToObservers()

void alexaClientSDK::kwd::test::MockKeyWordDetector::sendKeyWordCallToObservers ( )
inline

Notifies all KeyWordObservers with dummy values.

◆ sendStateChangeCallObservers()

void alexaClientSDK::kwd::test::MockKeyWordDetector::sendStateChangeCallObservers ( avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface::KeyWordDetectorState  state)
inline

Notifies all KeyWordDetectorStateObservers.

Parameters
stateThe state to notify observers of.

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

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