io.spokestack.spokestack.tts

Class TTSManager

java.lang.Object

io.spokestack.spokestack.tts.TTSManager

All Implemented Interfaces:

AutoCloseable

public final class TTSManager
extends Object
implements AutoCloseable

Manager for text-to-speech output in Spokestack.

Spokestack's TTS manager follows the same setup pattern as its speech pipeline, and the two APIs are similar, but the components operate independently.

The TTS manager establishes the external service that will be used to synthesize system prompts and, optionally, a component that handles playback of the resulting audio streams without the app having to manage Android media player resources. The following configuration enables both features, using Spokestack's TTS service to process synthesis requests and its output component to automatically play them:

 
 TTSManager ttsManager = new TTSManager.Builder()
     .setTTSServiceClass("io.spokestack.spokestack.tts.SpokestackTTSService")
     .setOutputClass("io.spokestack.spokestack.tts.SpokestackTTSOutput")
     .setProperty("spokestack-id", "f0bc990c-e9db-4a0c-a2b1-6a6395a3d97e")
     .setProperty(
         "spokestack-secret",
         "5BD5483F573D691A15CFA493C1782F451D4BD666E39A9E7B2EBE287E6A72C6B6")
     .setAndroidContext(getApplicationContext())
     .setLifecycle(getLifecycle())
     .build();
 
 

A TTS manager does not need to be explicitly started to do its job, but when it is no longer needed (or when certain Android lifecycle events occur), it's a good idea to call release() to free any resources it's holding. If an output class is specified, this is critical, as it may be holding a prepared Android media player.

Once released, an explicit call to prepare() is required to reallocate a manager's resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TTSManager.Builder TTS manager builder.

Method Summary

Modifier and Type	Method and Description
void	addListener(TTSListener listener) Add a new listener to receive events from the TTS subsystem.
void	close()
SpeechOutput	getOutput() Get the current speech output component.
TTSService	getTtsService() Get the current TTS service.
void	prepare() Dynamically constructs TTS component classes, allocating any resources they control.
void	registerLifecycle(androidx.lifecycle.Lifecycle newLifecycle) Registers the currently active lifecycle with the manager, allowing any output classes to handle media player components based on system lifecycle events.
void	release() Stops activity in the TTS subsystem and releases any resources held by its components.
void	removeListener(TTSListener listener) Remove a TTS listener, allowing it to be garbage collected.
void	setAndroidContext(android.content.Context androidContext) Sets the android context for the TTS Subsystem.
void	stopPlayback() Stops playback of any playing or queued synthesis results.
void	synthesize(SynthesisRequest request) Synthesizes a piece of text or SSML, dispatching the result to any registered listeners.

Methods inherited from class java.lang.Object

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

Method Detail

getTtsService

public TTSService getTtsService()

Get the current TTS service.

Returns:

The TTS service being managed by this subsystem.

getOutput

public SpeechOutput getOutput()

Get the current speech output component.

Returns:

The speech output component being managed by this subsystem.

synthesize

public void synthesize(SynthesisRequest request)

Synthesizes a piece of text or SSML, dispatching the result to any registered listeners.

Parameters:

request - The synthesis request data.

stopPlayback

public void stopPlayback()

Stops playback of any playing or queued synthesis results.

registerLifecycle

public void registerLifecycle(@NonNull
                              androidx.lifecycle.Lifecycle newLifecycle)

Registers the currently active lifecycle with the manager, allowing any output classes to handle media player components based on system lifecycle events.

Parameters:

newLifecycle - The current lifecycle.

setAndroidContext

public void setAndroidContext(android.content.Context androidContext)

Sets the android context for the TTS Subsystem. Some components may require an application context instead of an activity context; see individual component documentation for details.

Parameters:

androidContext - the android context for the TTS subsystem.

See Also:

SpokestackTTSOutput

addListener

public void addListener(TTSListener listener)

Add a new listener to receive events from the TTS subsystem.

Parameters:

listener - The listener to add.

removeListener

public void removeListener(TTSListener listener)

Remove a TTS listener, allowing it to be garbage collected.

Parameters:

listener - The listener to remove.

close

public void close()

Specified by:

close in interface AutoCloseable

prepare

public void prepare()
             throws Exception

Dynamically constructs TTS component classes, allocating any resources they control. It is only necessary to explicitly call this if the TTS subsystem's resources have been freed via release()} or close().

Throws:

Exception - If there is an error constructing TTS components.

release

public void release()

Stops activity in the TTS subsystem and releases any resources held by its components. No internally queued audio will be played after this method is called, and the queue will be cleared.

Once released, an explicit call to prepare() is required to reallocate a manager's resources.