org.jvoicexml

Interface UserInput

public interface UserInput

Facade for easy control and monitoring of the user's input.

Objects that implement this interface are able to detect and report character and/or spoken input simultaneously 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.

Method Summary

Modifier and Type	Method and Description
int	activateGrammars(java.util.Collection<GrammarDocument> grammars) Activates the given grammars.
int	deactivateGrammars(java.util.Collection<GrammarDocument> grammars) Deactivates the given grammars.
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(org.jvoicexml.xml.srgs.ModeType mode) Retrieves the grammar types that are supported by this implementation for the given mode.
void	startRecognition(DataModel model, java.util.Collection<org.jvoicexml.xml.srgs.ModeType> types, SpeechRecognizerProperties speech, DtmfRecognizerProperties dtmf) Detects and reports character and/or spoken input simultaneously.
void	stopRecognition(java.util.Collection<org.jvoicexml.xml.srgs.ModeType> types) Stops a previously started recognition.

Method Detail

startRecognition

void startRecognition(DataModel model,
                      java.util.Collection<org.jvoicexml.xml.srgs.ModeType> types,
                      SpeechRecognizerProperties speech,
                      DtmfRecognizerProperties dtmf)
               throws NoresourceError,
                      BadFetchError

Detects and reports character and/or spoken input simultaneously.

Parameters:

model - the data model for generating a semantic interpretation

types - the recognizer types to activate

speech - the speech recognizer properties to use

dtmf - the DTMF recognizer properties to use

Throws:

NoresourceError - The input resource is not available.

BadFetchError - The active grammar contains some errors.

stopRecognition

void stopRecognition(java.util.Collection<org.jvoicexml.xml.srgs.ModeType> types)

Stops a previously started recognition.

Parameters:

types - the recognizer types to activate, null would stop all recognizers

See Also:

startRecognition(org.jvoicexml.interpreter.datamodel.DataModel, java.util.Collection<org.jvoicexml.xml.srgs.ModeType>, org.jvoicexml.SpeechRecognizerProperties, org.jvoicexml.DtmfRecognizerProperties)

getSupportedGrammarTypes

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

Retrieves the grammar types that are supported by this implementation for the given mode.

It is guaranteed that the implementation is only asked to activate ( activateGrammars(Collection)) and deactivate ( deactivateGrammars(Collection)) grammars who's format is returned by this method.

Parameters:

mode - grammar mode

Returns:

supported grammars.

Since:

0.5.5

activateGrammars

int activateGrammars(java.util.Collection<GrammarDocument> grammars)
              throws BadFetchError,
                     UnsupportedLanguageError,
                     NoresourceError,
                     UnsupportedFormatError

Activates the given grammars. It is guaranteed that all grammars types are supported by this implementation. The supported grammar types are retrieved from getSupportedGrammarTypes(ModeType).

GrammarImplementations may be cached. This means that a grammar implementation object is loaded either by this or by another instance of the UserInput. For some implementation platforms it may be necessary that the instance activating the grammar also loaded the grammar. In these cases, the grammar implementation must be loaded in this call. The grammar source may be accessed by the grammar implementation itself, e.g. SRGS grammar sources can be accessed via SrgsXmlGrammarImplementation.getGrammarDocument() .

Parameters:

grammars - grammars to activate. This collection may contain grammars that already have been activated by a previous call to this method. It is up to the implementation to distinguish if the grammar is already active or not.

Returns:

number of activated grammars

Throws:

BadFetchError - Grammar is not known by the recognizer.

UnsupportedLanguageError - The specified language is not supported.

NoresourceError - The input resource is not available.

UnsupportedFormatError - the grammar format is not supported

deactivateGrammars

int deactivateGrammars(java.util.Collection<GrammarDocument> grammars)
                throws NoresourceError,
                       BadFetchError

Deactivates the given grammars. 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.

Returns:

number of deactivated grammars

Throws:

BadFetchError - Grammar is not known by the recognizer.

NoresourceError - The input resource is not available.

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.