org.jvoicexml.implementation

Interface SpokenInput

All Superinterfaces:

ExternalResource, InputDevice, RemoteConnectable

All Known Implementing Classes:

BufferedDtmfInput

public interface SpokenInput
extends ExternalResource, InputDevice

Facade for easy control and monitoring of the user's speech input as an external resource.

Objects that implement this interface are able to detect spoken input and to control input detection interval duration with a timer whose length is specified by a VoiceXML document.

If an input resource is not available, an error.noresource event must be thrown.

It is guaranteed that the session remains the same between the calls to RemoteConnectable.connect(org.jvoicexml.ConnectionInformation) and RemoteConnectable.disconnect(org.jvoicexml.ConnectionInformation).

Since:

0.5

Method Summary

Modifier and Type	Method and Description
void	activateGrammars(java.util.Collection<GrammarImplementation<?>> grammars) Activates the given grammars.
void	addListener(SpokenInputListener listener) Adds a listener for user input events.
void	deactivateGrammars(java.util.Collection<GrammarImplementation<?>> grammars) Deactivates the given grammar.
java.util.Collection<org.jvoicexml.xml.vxml.BargeInType>	getSupportedBargeInTypes() Retrieves the barge-in types supported by this UserInput.
java.util.Collection<org.jvoicexml.xml.srgs.GrammarType>	getSupportedGrammarTypes() Retrieves the grammar types that are supported by this implementation.
GrammarImplementation<?>	loadGrammar(java.net.URI uri, org.jvoicexml.xml.srgs.GrammarType type) Creates a GrammarImplementation from the contents provided by the Reader.
void	removeListener(SpokenInputListener listener) Removes a listener for user input events.

Methods inherited from interface org.jvoicexml.implementation.ExternalResource

activate, close, getType, isBusy, open, passivate

Methods inherited from interface org.jvoicexml.RemoteConnectable

connect, disconnect

Methods inherited from interface org.jvoicexml.implementation.InputDevice

startRecognition, stopRecognition

Method Detail

getSupportedGrammarTypes

java.util.Collection<org.jvoicexml.xml.srgs.GrammarType> getSupportedGrammarTypes()

Retrieves the grammar types that are supported by this implementation.

Returns:

supported grammars.

Since:

0.5.5

activateGrammars

void activateGrammars(java.util.Collection<GrammarImplementation<?>> grammars)
               throws BadFetchError,
                      UnsupportedLanguageError,
                      UnsupportedFormatError,
                      NoresourceError

Activates the given grammars. It is guaranteed that all grammars types are supported by this implementation.

It is guaranteed that the loadGrammar(URI, GrammarType) method is always called before a grammar becomes active via this method.

Parameters:

grammars - Grammars to activate.

Throws:

BadFetchError - Grammar is not known by the recognizer.

UnsupportedLanguageError - The specified language is not supported.

UnsupportedFormatError - the grammar format is not supported

NoresourceError - The input resource is not available.

deactivateGrammars

void deactivateGrammars(java.util.Collection<GrammarImplementation<?>> grammars)
                 throws NoresourceError,
                        BadFetchError

Deactivates the given grammar. Do nothing if the input resource is not available. It is guaranteed that all grammars types are supported by this implementation.

Parameters:

grammars - Grammars to deactivate.

Throws:

BadFetchError - Grammar is not known by the recognizer.

NoresourceError - The input resource is not available.

loadGrammar

GrammarImplementation<?> loadGrammar(java.net.URI uri,
                                     org.jvoicexml.xml.srgs.GrammarType type)
                              throws NoresourceError,
                                     java.io.IOException,
                                     UnsupportedFormatError

Creates a GrammarImplementation from the contents provided by the Reader. If the grammar contained in the Reader already exists, it is over-written.

This method is mainly needed for non SRGS grammars, e.g. JSGF. The grammar implementation is platform specific, so it the responsibility of the implementation platform to return load it's specific grammar. However, loading an SRGS grammar is quite easy and can be implemented e.g. as

final InputSource inputSource = new InputSource(reader);
SrgsXmlDocument doc = new SrgsXmlDocument(inputSource);
// Pass it to the recognizer
return doc;

Parameters:

uri - the URI to load the grammar

type - type of the grammar to read. The type is one of the supported types of the implementation, that has been requested via getSupportedGrammarTypes().

Returns:

Read grammar.

Throws:

NoresourceError - the input resource is not available.

java.io.IOException - error reading the grammar.

UnsupportedFormatError - invalid grammar format.

Since:

0.3

getSupportedBargeInTypes

java.util.Collection<org.jvoicexml.xml.vxml.BargeInType> getSupportedBargeInTypes()

Retrieves the barge-in types supported by this UserInput.

Returns:

Collection of supported barge-in types, an empty collection, if no types are supported.

addListener

void addListener(SpokenInputListener listener)

Adds a listener for user input events.

The implementation of this interface must notify the listener about all events.

Parameters:

listener - The listener.

Since:

0.5

removeListener

void removeListener(SpokenInputListener listener)

Removes a listener for user input events.

Parameters:

listener - The listener.

Since:

0.6