Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface:

Public Types
enum	SpeechSynthesizerState { SpeechSynthesizerState::PLAYING, SpeechSynthesizerState::FINISHED, SpeechSynthesizerState::INTERRUPTED, SpeechSynthesizerState::GAINING_FOCUS, SpeechSynthesizerState::LOSING_FOCUS }

Public Member Functions
virtual	~SpeechSynthesizerObserverInterface ()=default

virtual void	onStateChanged (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)=0

Detailed Description

Interface for observing a SpeechSynthesizer.

Member Enumeration Documentation

strong

This is an enum class used to indicate the state of the SpeechSynthesizer.

Enumerator
PLAYING	In this state, the `SpeechSynthesizer` is playing back the speech.
FINISHED	In this state, the `SpeechSynthesizer` is idle and not playing speech.
INTERRUPTED	In this state, the `SpeechSynthesizer` is idle due to a barge in.
GAINING_FOCUS	In this state, the `SpeechSynthesizer` is gaining the channel focus while still not playing anything.
LOSING_FOCUS	In this state, the `SpeechSynthesizer` is losing the channel focus but not yet considered `FINISHED`.

virtual alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::~SpeechSynthesizerObserverInterface ( )

virtualdefault

Destructor.

virtual void alexaClientSDK::avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface::onStateChanged	(	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
	)

pure virtual

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.

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

/workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/SpeechSynthesizerObserverInterface.h