io.spokestack.spokestack.tts

Enum TTSEvent.Type

java.lang.Object

java.lang.Enum<TTSEvent.Type>

io.spokestack.spokestack.tts.TTSEvent.Type

All Implemented Interfaces:

Serializable, Comparable<TTSEvent.Type>

Enclosing class:

TTSEvent

public static enum TTSEvent.Type
extends Enum<TTSEvent.Type>

Enum representing the type of event being dispatched.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUDIO_AVAILABLE A synthesis request has completed, and an audio URL has been received from the external service.
ERROR An error has occurred during synthesis or output.
PLAYBACK_COMPLETE The Spokestack-managed media player has finished playing all queued TTS synthesis requests.
PLAYBACK_STARTED The Spokestack-managed media player has started playing synthesized TTS audio.
PLAYBACK_STOPPED The Spokestack-managed media player has stopped playing audio (possibly because the system gave audio focus to another component), but may still have TTS data left to play.

Method Summary

Modifier and Type	Method and Description
static TTSEvent.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static TTSEvent.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUDIO_AVAILABLE

public static final TTSEvent.Type AUDIO_AVAILABLE

A synthesis request has completed, and an audio URL has been received from the external service. Note that audio synthesized by Spokestack must be played or downloaded within 30 seconds of URL generation, or it will become inaccessible.

PLAYBACK_COMPLETE

public static final TTSEvent.Type PLAYBACK_COMPLETE

The Spokestack-managed media player has finished playing all queued TTS synthesis requests.

PLAYBACK_STARTED

public static final TTSEvent.Type PLAYBACK_STARTED

The Spokestack-managed media player has started playing synthesized TTS audio.

PLAYBACK_STOPPED

public static final TTSEvent.Type PLAYBACK_STOPPED

The Spokestack-managed media player has stopped playing audio (possibly because the system gave audio focus to another component), but may still have TTS data left to play.

ERROR

public static final TTSEvent.Type ERROR

An error has occurred during synthesis or output.

Method Detail

values

public static TTSEvent.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TTSEvent.Type c : TTSEvent.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TTSEvent.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null