Inheritance diagram for alexaClientSDK::acsdkKWDImplementations::test::MockKeyWordDetector:

Collaboration diagram for alexaClientSDK::acsdkKWDImplementations::test::MockKeyWordDetector:

Public Member Functions
	MockKeyWordDetector (std::shared_ptr< acsdkKWDInterfaces::KeywordNotifierInterface > keywordNotifier, std::shared_ptr< acsdkKWDInterfaces::KeywordDetectorStateNotifierInterface > keywordDetectorStateNotifier)

void	sendKeyWordCallToObservers ()

void	sendStateChangeCallObservers (avsCommon::sdkInterfaces::KeyWordDetectorStateObserverInterface::KeyWordDetectorState state)

ssize_t	protectedReadFromStream (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)

Public Member Functions inherited from alexaClientSDK::acsdkKWDImplementations::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

Static Public Member Functions
static bool	protectedIsByteswappingRequired (avsCommon::utils::AudioFormat audioFormat)

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::acsdkKWDImplementations::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 >>(), bool supportsDavs=false)

	AbstractKeywordDetector (std::shared_ptr< acsdkKWDInterfaces::KeywordNotifierInterface > keywordNotifier, std::shared_ptr< acsdkKWDInterfaces::KeywordDetectorStateNotifierInterface > keyWordDetectorStateNotifier, bool supportsDavs=false)

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)

bool	isDavsSupported ()

Static Protected Member Functions inherited from alexaClientSDK::acsdkKWDImplementations::AbstractKeywordDetector
static bool	isByteswappingRequired (avsCommon::utils::AudioFormat audioFormat)

Detailed Description

A mock Keyword Detector that inherits from KeyWordDetector.

Constructor & Destructor Documentation

◆ MockKeyWordDetector()

alexaClientSDK::acsdkKWDImplementations::test::MockKeyWordDetector::MockKeyWordDetector	(	std::shared_ptr< acsdkKWDInterfaces::KeywordNotifierInterface >	keywordNotifier,
		std::shared_ptr< acsdkKWDInterfaces::KeywordDetectorStateNotifierInterface >	keywordDetectorStateNotifier
	)

inline

Constructor.

Parameters

keyWordNotifier	The object with which to notifiy observers of keyword detections.
KeyWordDetectorStateNotifier	The object with which to notify observers of state changes in the engine.

Member Function Documentation

◆ protectedIsByteswappingRequired()

bool alexaClientSDK::acsdkKWDImplementations::test::MockKeyWordDetector::protectedIsByteswappingRequired ( avsCommon::utils::AudioFormat audioFormat )

static

◆ protectedReadFromStream()

ssize_t alexaClientSDK::acsdkKWDImplementations::test::MockKeyWordDetector::protectedReadFromStream	(	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
	)

◆ sendKeyWordCallToObservers()

void alexaClientSDK::acsdkKWDImplementations::test::MockKeyWordDetector::sendKeyWordCallToObservers ( )

Notifies all KeyWordObservers with dummy values.

◆ sendStateChangeCallObservers()

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

Notifies all KeyWordDetectorStateObservers.

Parameters

state The state to notify observers of.

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

/workplace/avs-device-sdk/shared/KWD/acsdkKWDImplementations/test/AbstractKeywordDetectorTest.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members