io.spokestack.spokestack

Class SpeechOutput

java.lang.Object

io.spokestack.spokestack.tts.TTSComponent

io.spokestack.spokestack.SpeechOutput

All Implemented Interfaces:

TTSListener, AutoCloseable

Direct Known Subclasses:

SpokestackTTSOutput

public abstract class SpeechOutput
extends TTSComponent
implements AutoCloseable, TTSListener

Text-to-speech output.

This is the audio output interface for the Spokestack framework. Implementers receive an audio URL provided by a TTS service and must interact with a media player to play that audio, pausing the speech pipeline while the resulting audio plays if desired and then resuming it when playback is over.

SpeechOutput implementers are TTSListeners by definition; thus, if a TTS subsystem has an output class, additional listeners are not required. SpeechOutput components do publish their own events using the same interface, however, so an app may wish to include a listener component to receive media player events or errors. A separate listener is also useful for re-opening the microphone (activating the speech pipeline) when playback is complete.

To be used in a TTS subsystem, an implementing class must provide a constructor that accepts a SpeechConfig instance.

See Also:

TTSComponent

Constructor Summary

Constructors

Constructor and Description
SpeechOutput()

Method Summary

Modifier and Type	Method and Description
abstract void	audioReceived(AudioResponse response) Notifies the component that audio is available for immediate playback or caching at the specified location.
void	eventReceived(TTSEvent event) A notification that a TTS event has occurred.
abstract void	setAndroidContext(android.content.Context androidContext) Sets the output's Android context.
abstract void	stopPlayback() Stops playback of any currently playing and queued synthesis results and clears the play queue.

Methods inherited from class io.spokestack.spokestack.tts.TTSComponent

addListener, dispatch, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

SpeechOutput

public SpeechOutput()

Method Detail

eventReceived

public void eventReceived(@NonNull
                          TTSEvent event)

Description copied from interface: TTSListener

A notification that a TTS event has occurred. This can represent a response from a third-party TTS service, a player event from the output component, or an error from either component.

Specified by:

eventReceived in interface TTSListener

Parameters:

event - The event from the TTS system.

audioReceived

public abstract void audioReceived(AudioResponse response)

Notifies the component that audio is available for immediate playback or caching at the specified location.

Parameters:

response - The TTS response containing the URI of the synthesized audio.

stopPlayback

public abstract void stopPlayback()

Stops playback of any currently playing and queued synthesis results and clears the play queue.

setAndroidContext

public abstract void setAndroidContext(android.content.Context androidContext)

Sets the output's Android context.

Parameters:

androidContext - The Android context.