alexaClientSDK::integration::test::TestSpeechSynthesizerObserver Class Reference

#include <TestSpeechSynthesizerObserver.h>

Inheritance diagram for alexaClientSDK::integration::test::TestSpeechSynthesizerObserver:

Collaboration diagram for alexaClientSDK::integration::test::TestSpeechSynthesizerObserver:

Public Member Functions
	TestSpeechSynthesizerObserver ()
	~TestSpeechSynthesizerObserver ()=default
void	onStateChanged (avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState state, const avsCommon::utils::mediaPlayer::MediaPlayerInterface::SourceId mediaSourceId, const avsCommon::utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState > &mediaPlayerState, const std::vector< avsCommon::utils::audioAnalyzer::AudioAnalyzerState > &audioAnalyzerState) override
bool	checkState (const avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState expectedState, const std::chrono::seconds duration)
avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState	waitForNext (const std::chrono::seconds duration)
avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState	getCurrentState ()
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface
virtual	~SpeechSynthesizerObserverInterface ()=default

Additional Inherited Members
Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface
enum	SpeechSynthesizerState {   SpeechSynthesizerState::PLAYING, SpeechSynthesizerState::FINISHED, SpeechSynthesizerState::INTERRUPTED, SpeechSynthesizerState::GAINING_FOCUS,   SpeechSynthesizerState::LOSING_FOCUS }

Detailed Description

Interface for observing a SpeechSynthesizer.

Constructor & Destructor Documentation

TestSpeechSynthesizerObserver()

alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::TestSpeechSynthesizerObserver

(

)

~TestSpeechSynthesizerObserver()

alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::~TestSpeechSynthesizerObserver ( )

default

Member Function Documentation

checkState()

bool alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::checkState	(	const avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState	expectedState,
		const std::chrono::seconds	duration
	)

getCurrentState()

SpeechSynthesizerObserverInterface::SpeechSynthesizerState alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::getCurrentState

(

)

onStateChanged()

void alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::onStateChanged ( avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::SpeechSynthesizerState  state, const avsCommon::utils::mediaPlayer::MediaPlayerInterface::SourceId  mediaSourceId, const avsCommon::utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState > &  mediaPlayerState, const std::vector< avsCommon::utils::audioAnalyzer::AudioAnalyzerState > &  audioAnalyzerState  )

overridevirtual

Notification that the SpeechSynthesizer state has changed. Callback functions must return as soon as possible.

Parameters

state	The new state of the speechSynthesizer.
mediaSourceId	The current media source id for SpeechSynthesizer
mediaPlayerState	Optional state of the media player as of this state change. The Optional is blank if the state is unavailable.
audioAnalyzerState	states of the audio analyzers related to the speech output.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface.

waitForNext()

SpeechSynthesizerObserverInterface::SpeechSynthesizerState alexaClientSDK::integration::test::TestSpeechSynthesizerObserver::waitForNext

(

const std::chrono::seconds

duration

)

---

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

• /workplace/avs-device-sdk/Integration/include/Integration/TestSpeechSynthesizerObserver.h
• /workplace/avs-device-sdk/Integration/src/TestSpeechSynthesizerObserver.cpp