Package com.vivoka.vsdk.tts

Enum Class Channel.EventCode

java.lang.Object

java.lang.Enum<Channel.EventCode>

com.vivoka.vsdk.tts.Channel.EventCode

All Implemented Interfaces:

Serializable, Comparable<Channel.EventCode>, Constable

Enclosing class:

Channel

public static enum Channel.EventCode
extends Enum<Channel.EventCode>

Enumeration of event codes for channel events.
The events occur in the following order:

1. TEXT_REWRITTEN – emitted when the text is rewritten
2. GENERATION_STARTED – emitted when generation starts
3. Zero or more regular events:
   1. MARKER – emitted when a marker tag is reached
   2. WORD_MARKER_START – emitted when a word marker start is reached
   3. WORD_MARKER_END – emitted when a word marker end is reached
4. GENERATION_ENDED – emitted when generation ends
5. PROCESS_FINISHED – emitted when processing has finished

Note: NATIVE_EVENT may occur at any time during execution if native events are enabled.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GENERATION_ENDED	The generation has ended.
GENERATION_STARTED	The generation has started.
MARKER	A marker tag has been reached (Deprecated).
NATIVE_EVENT	A native event
PROCESS_FINISHED	The process has finished
TEXT_REWRITTEN	The text has been rewritten and ready to start generation.
WORD_MARKER_END	A word marker end has been reached.
WORD_MARKER_START	A word marker start has been reached.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT_REWRITTEN

public static final Channel.EventCode TEXT_REWRITTEN

The text has been rewritten and ready to start generation.

GENERATION_STARTED

public static final Channel.EventCode GENERATION_STARTED

The generation has started.

MARKER

public static final Channel.EventCode MARKER

A marker tag has been reached (Deprecated).

WORD_MARKER_START

public static final Channel.EventCode WORD_MARKER_START

A word marker start has been reached. The end position and time are not available.

WORD_MARKER_END

public static final Channel.EventCode WORD_MARKER_END

A word marker end has been reached. The end position and time are available.

GENERATION_ENDED

public static final Channel.EventCode GENERATION_ENDED

The generation has ended.

PROCESS_FINISHED

public static final Channel.EventCode PROCESS_FINISHED

The process has finished

NATIVE_EVENT

public static final Channel.EventCode NATIVE_EVENT

A native event

Method Details

values

public static Channel.EventCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Channel.EventCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null