Package org.jvoicexml

This package contains the user relevant interfaces and classes to interact with the JVoiceXML VoiceXML interpreter.

See: Description

Interface Summary

Interface	Description
Application	An Application is a set of documents sharing the same application root document.
CallControl	Call control.
CallManager	Manager for telephony integration to allow for real client-server scenarios.
Configurable	A component that requires further configuration.
Configuration	JVoiceXML configuration.
ConnectionInformation	Data container that holds all the information that is needed to connect the server side resources SystemOutput, UserInput, and CallControl to the client.
DocumentServer	A document server processes requests from a client application.
DtmfInput	Facade for easy control and monitoring of the user's DTMF input.
GrammarDocument	Grammar document that is retrieved from the DocumentServer.
ImplementationPlatform	The implementation platform is controlled by the VoiceXML interpreter context and by the VoiceXML interpreter.
ImplementationPlatformFactory	Factory for ImplementationPlatforms.
JndiSupport	JNDI support for remote access to the VoiceXML interpreter.
JVoiceXml	Main entry point for all ConnectionInformations.
JVoiceXmlCore	View of the interpreter on the main class.
JVoiceXmlMainListener	A listener to monitor the states of JVoiceXmlMain.
PromptAccumulator	A prompt accumulator collects all the prompts that are to be rendered in the SystemOutput.
RecognitionResult	Result of the recognition process.
RemoteConnectable	Objects that implement this interface can be connected to a client using the information given in ConnectionInformation.
Session	A session begins when the user starts to interact with a VoiceXML interpreter context, continues as documents are loaded and processed, and ends when requested by the user, a document, or the interpreter context.
SessionListener	A listener for the Session.
SpeakableText	Objects that implement this interface contain some text, that is passed to the TTS engine.
SystemOutput	Facade for easy access to the system output.
UserInput	Facade for easy control and monitoring of the user's input.

Class Summary

Class	Description
CallControlProperties	Generic telephony properties.
DocumentDescriptor	Attributes describing a VoiceXML document to retrieve from the DocumentServer.
DtmfRecognizerProperties	Generic DTMF recognizer properties as described in http://www.w3.org/TR/voicexml20#dml6.3.3.
FetchAttributes	A VoiceXML interpreter context needs to fetch VoiceXML documents, and other resources, such as audio files, grammars, scripts, and objects.
JVoiceXmlMain	Main class of the JVoiceXML VoiceXML interpreter.
LastResult	This variable container holds information about the last recognition to occur within this application.
SpeakableSsmlText	Text to be passed to the TTS engine.
SpeechRecognizerProperties	Generic speech recognizer properties as described in http://www.w3.org/TR/voicexml20#dml6.3.2.

Enum Summary

Enum	Description
InterpreterState	States of JVoiceXML that are passed throughout the lifecycle.

Exception Summary

Exception	Description
ConfigurationException	Error configuring a component.

Package org.jvoicexml Description

This package contains the user relevant interfaces and classes to interact with the JVoiceXML VoiceXML interpreter.

An overview about the architecture is given in the following figure: