#include <SpeechSynthesizer.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer:

[legend]

Collaboration diagram for alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer:

[legend]

Public Types
using	SpeechSynthesizerObserverInterface = avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface
	Alias to the `SpeechSynthesizerObserverInterface` for brevity. More...

Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
enum	DialogUXState { DialogUXState::IDLE, DialogUXState::LISTENING, DialogUXState::EXPECTING, DialogUXState::THINKING, DialogUXState::SPEAKING, DialogUXState::FINISHED }
	The different dialog specific AVS UX states. More...

Public Types inherited from alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface
enum	TagType { TagType::STRING, TagType::UINT, TagType::INT, TagType::DOUBLE, TagType::BOOLEAN }
	The different types of metadata "stream tags". More...

using	SourceId = MediaPlayerInterface::SourceId
	A type that identifies which source is currently being operated on. More...

typedef std::vector< TagKeyValueType >	VectorOfTags

Public Member Functions
void	onDialogUXStateChanged (DialogUXState newState) override

avsCommon::avs::DirectiveHandlerConfiguration	getConfiguration () const override

void	addObserver (std::shared_ptr< SpeechSynthesizerObserverInterface > observer)

void	removeObserver (std::shared_ptr< SpeechSynthesizerObserverInterface > observer)

void	onDeregistered () override

void	handleDirectiveImmediately (std::shared_ptr< avsCommon::avs::AVSDirective > directive) override

void	preHandleDirective (std::shared_ptr< DirectiveInfo > info) override

void	handleDirective (std::shared_ptr< DirectiveInfo > info) override

void	cancelDirective (std::shared_ptr< DirectiveInfo > info) override

void	provideState (const avsCommon::avs::NamespaceAndName &stateProviderName, const unsigned int stateRequestToken) override

void	onContextAvailable (const std::string &jsonContext) override

void	onContextFailure (const avsCommon::sdkInterfaces::ContextRequestError error) override

Overridden ChannelObserverInterface methods.
void	onFocusChanged (avsCommon::avs::FocusState newFocus, avsCommon::avs::MixingBehavior behavior) override

Overridden MediaPlayerObserverInterface methods.
void	onFirstByteRead (SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState &state) override

void	onPlaybackStarted (SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState &state) override

void	onPlaybackFinished (SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState &state) override

void	onPlaybackError (SourceId id, const avsCommon::utils::mediaPlayer::ErrorType &type, std::string error, const avsCommon::utils::mediaPlayer::MediaPlayerState &state) override

void	onPlaybackStopped (SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState &state) override

void	onBufferUnderrun (SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState &state) override

CapabilityConfigurationInterface Functions
std::unordered_set< std::shared_ptr< avsCommon::avs::CapabilityConfiguration > >	getCapabilityConfigurations () override

Public Member Functions inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
virtual	~CapabilityAgent ()=default

void	preHandleDirective (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result) override final

bool	handleDirective (const std::string &messageId) override final

void	cancelDirective (const std::string &messageId) override final

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface
virtual	~DirectiveHandlerInterface ()=default

virtual void	preHandleDirective (std::shared_ptr< avsCommon::avs::AVSDirective > directive, std::unique_ptr< DirectiveHandlerResultInterface > result)=0

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface
virtual	~ChannelObserverInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface
virtual	~StateProviderInterface ()=default

virtual void	provideState (const avs::CapabilityTag &stateProviderName, const ContextRequestToken stateRequestToken)

virtual bool	canStateBeRetrieved ()

virtual bool	hasReportableStateProperties ()

virtual bool	shouldQueryState ()

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface
virtual	~ContextRequesterInterface ()=default

virtual void	onContextAvailable (const endpoints::EndpointIdentifier &endpointId, const avs::AVSContext &endpointContext, ContextRequestToken requestToken)

virtual void	onContextFailure (const ContextRequestError error, ContextRequestToken token)

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
virtual	~DialogUXStateObserverInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface
virtual	~CapabilityConfigurationInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface
virtual	~MediaPlayerObserverInterface ()=default

virtual void	onFirstByteRead (SourceId id, const MediaPlayerState &state)=0

virtual void	onPlaybackStarted (SourceId id, const MediaPlayerState &state)=0

virtual void	onPlaybackFinished (SourceId id, const MediaPlayerState &state)=0

virtual void	onPlaybackError (SourceId id, const ErrorType &type, std::string error, const MediaPlayerState &state)=0

virtual void	onPlaybackPaused (SourceId, const MediaPlayerState &)

virtual void	onPlaybackResumed (SourceId, const MediaPlayerState &)

virtual void	onPlaybackStopped (SourceId, const MediaPlayerState &)

virtual void	onBufferUnderrun (SourceId, const MediaPlayerState &)

virtual void	onBufferRefilled (SourceId, const MediaPlayerState &)

virtual void	onBufferingComplete (SourceId, const MediaPlayerState &)

virtual void	onSeeked (SourceId, const MediaPlayerState &, const MediaPlayerState &)

virtual void	onTags (SourceId, std::unique_ptr< const VectorOfTags >, const MediaPlayerState &)

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)

virtual	~RequiresShutdown ()
	Destructor. More...

const std::string &	name () const

void	shutdown ()

bool	isShutdown () const

Static Public Member Functions
static std::shared_ptr< SpeechSynthesizer >	createSpeechSynthesizer (std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface > audioPipelineFactory, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface > focusManager, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder, std::shared_ptr< avsCommon::avs::DialogUXStateAggregator > dialogUXStateAggregator, std::shared_ptr< captions::CaptionManagerInterface > captionManager=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > powerResourceManager=nullptr)

static std::shared_ptr< SpeechSynthesizer >	create (std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > mediaPlayer, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface > focusManager, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder, std::shared_ptr< avsCommon::avs::DialogUXStateAggregator > dialogUXStateAggregator, std::shared_ptr< captions::CaptionManagerInterface > captionManager=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > powerResourceManager=nullptr)

Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
static std::string	stateToString (DialogUXState state)

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
	CapabilityAgent (const std::string &nameSpace, std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender)

virtual std::shared_ptr< DirectiveInfo >	createDirectiveInfo (std::shared_ptr< AVSDirective > directive, std::unique_ptr< sdkInterfaces::DirectiveHandlerResultInterface > result)

void	removeDirective (const std::string &messageId)

void	sendExceptionEncounteredAndReportFailed (std::shared_ptr< DirectiveInfo > info, const std::string &message, avsCommon::avs::ExceptionErrorType type=avsCommon::avs::ExceptionErrorType::INTERNAL_ERROR)

const std::pair< std::string, std::string >	buildJsonEventString (const std::string &eventName, const std::string &dialogRequestIdString="", const std::string &payload="{}", const std::string &context="") const

Protected Attributes inherited from alexaClientSDK::avsCommon::avs::CapabilityAgent
const std::string	m_namespace
	The namespace of the capability agent. More...

std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface >	m_exceptionEncounteredSender
	Object to use to send exceptionEncountered messages. More...

Detailed Description

This class implements the SpeechSynthesizer capability agent.

See also: https://developer.amazon.com/public/solutions/alexa/alexa-voice-service/reference/speechsynthesizer

Member Typedef Documentation

◆ SpeechSynthesizerObserverInterface

using alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::SpeechSynthesizerObserverInterface = avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface

Alias to the SpeechSynthesizerObserverInterface for brevity.

Member Function Documentation

◆ addObserver()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::addObserver ( std::shared_ptr< SpeechSynthesizerObserverInterface > observer )

Add an observer to the SpeechSynthesizer.

Parameters

observer The observer to add.

◆ cancelDirective()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::cancelDirective ( std::shared_ptr< DirectiveInfo > info )

overridevirtual

Cancel an ongoing preHandleDirective() or handleDirective() operation for the AVSDirective in . Once this has been called the CapabilityAgent should not expect to receive further calls regarding this directive.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Parameters

info	The `DirectiveInfo` instance for the `AVSDirective` to process.

Implements alexaClientSDK::avsCommon::avs::CapabilityAgent.

◆ create()

static std::shared_ptr<SpeechSynthesizer> alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::create	(	std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	mediaPlayer,
		std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >	messageSender,
		std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface >	focusManager,
		std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >	contextManager,
		std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >	exceptionSender,
		std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >	metricRecorder,
		std::shared_ptr< avsCommon::avs::DialogUXStateAggregator >	dialogUXStateAggregator,
		std::shared_ptr< captions::CaptionManagerInterface >	captionManager = `nullptr`,
		std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface >	powerResourceManager = `nullptr`
	)

static

Create a new SpeechSynthesizer instance.

Parameters

mediaPlayer	The instance of the `MediaPlayerInterface` used to play audio.
messageSender	The instance of the `MessageSenderInterface` used to send events to AVS.
focusManager	The instance of the `FocusManagerInterface` used to acquire focus of a channel.
contextManager	The instance of the `ContextObserverInterface` to use to set the context of the `SpeechSynthesizer`.
metricRecorder	The instance of the `MetricRecorderInterface` used to record metrics
exceptionSender	The instance of the `ExceptionEncounteredSenderInterface` to use to notify AVS when a directive cannot be processed.
captionManager	The optional `CaptionManagerInterface` instance to use for handling captions.
powerResourceManager	Power Resource Manager.

Returns: Returns a new SpeechSynthesizer, or nullptr if the operation failed.

◆ createSpeechSynthesizer()

static std::shared_ptr<SpeechSynthesizer> alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::createSpeechSynthesizer	(	std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface >	audioPipelineFactory,
		std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >	messageSender,
		std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface >	focusManager,
		std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >	contextManager,
		std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >	exceptionSender,
		std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >	metricRecorder,
		std::shared_ptr< avsCommon::avs::DialogUXStateAggregator >	dialogUXStateAggregator,
		std::shared_ptr< captions::CaptionManagerInterface >	captionManager = `nullptr`,
		std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface >	powerResourceManager = `nullptr`
	)

static

Create a new SpeechSynthesizer instance.

Parameters

audioPipelineFactory	The instance of `ApplicationAudioPipelineFactoryInterface` to create the speak media player and related interfaces.
messageSender	The instance of the `MessageSenderInterface` used to send events to AVS.
focusManager	The instance of the `FocusManagerInterface` used to acquire focus of a channel.
contextManager	The instance of the `ContextObserverInterface` to use to set the context of the `SpeechSynthesizer`.
metricRecorder	The instance of the `MetricRecorderInterface` used to record metrics
exceptionSender	The instance of the `ExceptionEncounteredSenderInterface` to use to notify AVS when a directive cannot be processed.
captionManager	The optional `CaptionManagerInterface` instance to use for handling captions.
powerResourceManager	Power Resource Manager.

Returns: Returns a new SpeechSynthesizer, or nullptr if the operation failed.

◆ getCapabilityConfigurations()

std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration> > alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::getCapabilityConfigurations ( )

overridevirtual

Returns the configurations of the capability interfaces being implemented.

Returns: A set of CapabilityConfigurations

Implements alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface.

◆ getConfiguration()

avsCommon::avs::DirectiveHandlerConfiguration alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::getConfiguration ( ) const

overridevirtual

Returns the configuration of the directive handler.

The configuration consists of multiple directive routing rules and their respective blocking policy. The directives will be matched from the most specific rule (with all fields defined) to the least specific rule (which only matches the directive endpointId).

Returns: The avs::DirectiveHandlerConfiguration of the handler.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.

◆ handleDirective()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::handleDirective ( std::shared_ptr< DirectiveInfo > info )

overridevirtual

Handle the action specified by the AVSDirective in info. The handling of subsequent directives with the same DialogRequestId may be blocked until the DirectiveHandler calls the setSucceeded() method of the DirectiveHandlingResult present in info. If handling of this directive fails setFailed() should be called to indicate a failure.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Parameters

info	The `DirectiveInfo` instance for the `AVSDirective` to process.

Implements alexaClientSDK::avsCommon::avs::CapabilityAgent.

◆ handleDirectiveImmediately()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::handleDirectiveImmediately ( std::shared_ptr< avsCommon::avs::AVSDirective > directive )

overridevirtual

Handle the action specified AVSDirective. Once this has been called the DirectiveHandler should not expect to receive further calls regarding this directive.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.; If this operation fails, an ExceptionEncountered message should be sent to AVS.

Parameters

directive The directive to handle.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface.

◆ onBufferUnderrun()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onBufferUnderrun	(	SourceId	id,
		const avsCommon::utils::mediaPlayer::MediaPlayerState &	state
	)

override

◆ onContextAvailable()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onContextAvailable ( const std::string & jsonContext )

overridevirtual

This is called by the ContextManager once the context is ready and available.

Deprecated:: This method is being deprecated since it cannot specify the source endpoint.

Note: The ContextRequester should perform minimum processing and return quickly. Otherwise it will block the processing of updating the of other ContextProviders.

Parameters

jsonContext Context information.Context provided is of the format {"context"[{...}, {...}]}

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface.

◆ onContextFailure()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onContextFailure ( const avsCommon::sdkInterfaces::ContextRequestError error )

overridevirtual

The contextManager calls this if it is unable to process a getContext request successfully.

Deprecated:: This method is being deprecated since it cannot specify the optional token.

Note: The ContextRequester should perform minimum processing and return quickly. Otherwise it will block the processing of updating the of other ContextProviders.

Parameters

error The reason why the getContext request failed.

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface.

◆ onDeregistered()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onDeregistered ( )

overridevirtual

Notification that this handler has been de-registered and will not receive any more calls.

Reimplemented from alexaClientSDK::avsCommon::avs::CapabilityAgent.

◆ onDialogUXStateChanged()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onDialogUXStateChanged ( DialogUXState newState )

overridevirtual

This function is called whenever the AVS UX dialog state of the system changes. This function will block processing of other state changes, so any implementation of this should return quickly.

Parameters

newState The new dialog specific AVS UX state.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface.

◆ onFirstByteRead()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onFirstByteRead	(	SourceId	id,
		const avsCommon::utils::mediaPlayer::MediaPlayerState &	state
	)

override

◆ onFocusChanged()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onFocusChanged	(	avsCommon::avs::FocusState	newFocus,
		avsCommon::avs::MixingBehavior	behavior
	)

overridevirtual

Used to notify the observer of the Channel of focus changes. Once called, the client should make a user observable change only and return immediately. Any additional work that needs to be done should be done on a separate thread or after returning. "User observable change" here refers to events that the end user of the product can visibly see or hear. For example, Alexa speech or music playing would be examples of user observable changes. Other work, such as database storing, logging, or communicating via network should be done on a different thread. Not doing so could result in delays for other clients trying to access the Channel.

Parameters

newFocus	The new Focus of the channel.
behavior	The mixingBehavior for the ChannelObserver to take as per the interrupt model

Note: when newFocus is FocusState::FOREGROUND, the MixingBehavior shall be guaranteed to be PRIMARY when newFocus is FocusState::NONE, the MixingBehavior shall be guaranteed to be MUST_STOP

Reimplemented from alexaClientSDK::avsCommon::avs::CapabilityAgent.

◆ onPlaybackError()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onPlaybackError	(	SourceId	id,
		const avsCommon::utils::mediaPlayer::ErrorType &	type,
		std::string	error,
		const avsCommon::utils::mediaPlayer::MediaPlayerState &	state
	)

override

◆ onPlaybackFinished()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onPlaybackFinished	(	SourceId	id,
		const avsCommon::utils::mediaPlayer::MediaPlayerState &	state
	)

override

◆ onPlaybackStarted()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onPlaybackStarted	(	SourceId	id,
		const avsCommon::utils::mediaPlayer::MediaPlayerState &	state
	)

override

◆ onPlaybackStopped()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::onPlaybackStopped	(	SourceId	id,
		const avsCommon::utils::mediaPlayer::MediaPlayerState &	state
	)

override

◆ preHandleDirective()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::preHandleDirective ( std::shared_ptr< DirectiveInfo > info )

overridevirtual

Notification that a directive has arrived. This notification gives the DirectiveHandler a chance to prepare for handling of an AVSDirective. If an error occurs during the pre-Handling phase and that error should cancel the handling of subsequent AVSDirectives with the same DialogRequestId, the DirectiveHandler should call the setFailed method on the result instance passed in to this call.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Parameters

info	The `DirectiveInfo` instance for the `AVSDirective` to process.

Implements alexaClientSDK::avsCommon::avs::CapabilityAgent.

◆ provideState()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::provideState	(	const avsCommon::avs::NamespaceAndName &	stateProviderName,
		const unsigned int	stateRequestToken
	)

overridevirtual

A request to a StateProvider to provide the state. The StateProvider should perform minimum processing and return quickly, otherwise it will block the processing of updating the states of other StateProviders. The ContextManager specifies a token which it uses to track the getContext request associated with this provideState request. The stateProviderInterface must use the same token when it updates its state via the setState call.

: The setState method MUST be called from a different thread from where the provideState method is being called from.

Parameters

stateProviderName	The name of the state provider.
stateRequestToken	The token to use in the `setState` call.

Deprecated:: NamespaceAndName is being deprecated. Use the CapabilityMessageIdentifier version instead.

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface.

◆ removeObserver()

void alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer::removeObserver ( std::shared_ptr< SpeechSynthesizerObserverInterface > observer )

Remove an observer from the SpeechSynthesizer.

Note: This is a synchronous call which can not be made by an observer callback. Attempting to call removeObserver() from SpeechSynthesizerObserverInterface::onStateChanged() will result in a deadlock.

Parameters

observer The observer to remove.

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

/workplace/avs-device-sdk/CapabilityAgents/SpeechSynthesizer/include/SpeechSynthesizer/SpeechSynthesizer.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SpeechSynthesizerObserverInterface

Member Function Documentation

◆ addObserver()

◆ cancelDirective()

◆ create()

◆ createSpeechSynthesizer()

◆ getCapabilityConfigurations()

◆ getConfiguration()

◆ handleDirective()

◆ handleDirectiveImmediately()

◆ onBufferUnderrun()

◆ onContextAvailable()

◆ onContextFailure()

◆ onDeregistered()

◆ onDialogUXStateChanged()

◆ onFirstByteRead()

◆ onFocusChanged()

◆ onPlaybackError()

◆ onPlaybackFinished()

◆ onPlaybackStarted()

◆ onPlaybackStopped()

◆ preHandleDirective()

◆ provideState()

◆ removeObserver()