org.jvoicexml.event.plain.implementation

Class InputStartedEvent

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.plain.implementation.SpokenInputEvent

org.jvoicexml.event.plain.implementation.InputStartedEvent

All Implemented Interfaces:

java.io.Serializable

public final class InputStartedEvent
extends SpokenInputEvent

Notification that the the user started to speak.

Since:

0.7.7

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DETAIL The detailing part.
static java.lang.String	EVENT_TYPE The detail message.

Fields inherited from class org.jvoicexml.event.plain.implementation.SpokenInputEvent

INPUT_STARTED, RECOGNITION_STARTED, RECOGNITION_STOPPED, RESULT_ACCEPTED, RESULT_REJECTED

Constructor Summary

Constructors

Constructor and Description
InputStartedEvent(SpokenInput input, java.lang.String sessionId, org.jvoicexml.xml.srgs.ModeType modeType) Constructs a new event with the event type as its detail message.

Method Summary

Modifier and Type	Method and Description
org.jvoicexml.xml.srgs.ModeType	getMode() Retrieves the mode type.

Methods inherited from class org.jvoicexml.event.plain.implementation.SpokenInputEvent

getEventType, getSessionId, getSource

Methods inherited from class org.jvoicexml.event.JVoiceXMLEvent

getMessage, isType

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

DETAIL

public static final java.lang.String DETAIL

The detailing part.

See Also:

Constant Field Values

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

The detail message.

Constructor Detail

InputStartedEvent

public InputStartedEvent(SpokenInput input,
                         java.lang.String sessionId,
                         org.jvoicexml.xml.srgs.ModeType modeType)

Constructs a new event with the event type as its detail message. The cause is not initialized

The DETAIL is used to construct the event type.

Parameters:

input - object that caused the event.

sessionId - the session id

modeType - input mode

See Also:

SpokenInputEvent.getEventType()

Method Detail

getMode

public org.jvoicexml.xml.srgs.ModeType getMode()

Retrieves the mode type.

Returns:

the mode type