io.spokestack.spokestack.tts

Class TTSEvent

java.lang.Object

io.spokestack.spokestack.tts.TTSEvent

public final class TTSEvent
extends Object

A wrapper for events in the TTS subsystem. TTS events include responses from external voice synthesis services and media events from player components.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TTSEvent.Type Enum representing the type of event being dispatched.

Field Summary

Fields

Modifier and Type	Field and Description
TTSEvent.Type	type The event type.

Constructor Summary

Constructors

Constructor and Description
TTSEvent(TTSEvent.Type eventType) Create an event with the specified type containing no other data.

Method Summary

Modifier and Type	Method and Description
Throwable	getError() Get the error represented by this event.
AudioResponse	getTtsResponse() Get the response data containing synthesized audio.
void	setError(Throwable error) Set the error represented by this event.
void	setTtsResponse(AudioResponse response) Attach response data containing the location of synthesized audio.

Methods inherited from class java.lang.Object

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

Field Detail

type

public final TTSEvent.Type type

The event type.

Constructor Detail

TTSEvent

public TTSEvent(TTSEvent.Type eventType)

Create an event with the specified type containing no other data.

Parameters:

eventType - The event type.

Method Detail

getTtsResponse

public AudioResponse getTtsResponse()

Get the response data containing synthesized audio.

Returns:

The TTS synthesis response.

setTtsResponse

public void setTtsResponse(AudioResponse response)

Attach response data containing the location of synthesized audio.

Parameters:

response - A response from a TTS service.

getError

public Throwable getError()

Get the error represented by this event.

Returns:

An error that occurred in the TTS subsystem.

setError

public void setError(Throwable error)

Set the error represented by this event.

Parameters:

error - An error that occurred in the TTS subsystem.