org.jvoicexml

Class SpeechRecognizerProperties

java.lang.Object

org.jvoicexml.SpeechRecognizerProperties

public class SpeechRecognizerProperties
extends java.lang.Object

Generic speech recognizer properties as described in http://www.w3.org/TR/voicexml20#dml6.3.2. See there for a more detailed description of the parameters.

This class must be extended to specify platform specific values.

Since:

0.7.5

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_CONFIDENCE_LEVEL The default confidence level.
static float	DEFAULT_SENSITIVITY The default sensitivity.
static float	DEFAULT_SPEED_VS_ACCURACY The default balance between speed vs. accuracy.
static java.lang.String	PROPERTY_COMPLETE_TIMEOUT Name of the completetimeout property.
static java.lang.String	PROPERTY_CONFIDENCE_LEVEL Name of the confidencelevel property.
static java.lang.String	PROPERTY_INCOMPLETE_TIMEOUT Name of the incompletetimeout property.
static java.lang.String	PROPERTY_MAX_SPEECH_TIMEOUT Name of the maxspeechtimeout property.
static java.lang.String	PROPERTY_SENSITIVITY Name of the sensitivity property.
static java.lang.String	PROPERTY_SPEED_VS_ACCURACY Name of the speedvsaccuracy property.

Constructor Summary

Constructors

Constructor and Description
SpeechRecognizerProperties() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
long	getCompletetimeoutAsMsec() Retrieves the length of silence required following user speech before the speech recognizer finalizes a result.
float	getConfidencelevel() Retrieves the confidence level.
long	getIncompletetimeoutAsMsec() Retrieves the required length of silence following user speech after which a recognizer finalizes a result.
long	getMaxspeechtimeoutAsMsec() /* Retrieves the maximum duration of user speech.
float	getSensitivity() Retrieves the sensitivity.
float	getSpeedvsaccuracy() Retrieves a hint specifying the desired balance between speed vs.
void	setCompletetimeout(java.lang.String value) Sets the length of silence required following user speech before the speech recognizer finalizes a result.
void	setConfidencelevel(float value) Sets the confidence level.
protected void	setEnhancedProperties(java.util.Map<java.lang.String,java.lang.String> props) May be used to set custom properties if this class is extended.
void	setIncompletetimeout(java.lang.String value) Sets the required length of silence following user speech after which a recognizer finalizes a result.
void	setMaxspeechtimeout(java.lang.String value) /* Sets the maximum duration of user speech.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> props) Retrieves the speech recognizer properties from the given map.
void	setSensitivity(float value) Sets the sensitivity.
void	setSpeedvsaccuracy(float value) Sets the hint specifying the desired balance between speed vs.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_CONFIDENCE_LEVEL

public static final java.lang.String PROPERTY_CONFIDENCE_LEVEL

Name of the confidencelevel property.

See Also:

Constant Field Values

PROPERTY_SENSITIVITY

public static final java.lang.String PROPERTY_SENSITIVITY

Name of the sensitivity property.

See Also:

Constant Field Values

PROPERTY_SPEED_VS_ACCURACY

public static final java.lang.String PROPERTY_SPEED_VS_ACCURACY

Name of the speedvsaccuracy property.

See Also:

Constant Field Values

PROPERTY_COMPLETE_TIMEOUT

public static final java.lang.String PROPERTY_COMPLETE_TIMEOUT

Name of the completetimeout property.

See Also:

Constant Field Values

PROPERTY_INCOMPLETE_TIMEOUT

public static final java.lang.String PROPERTY_INCOMPLETE_TIMEOUT

Name of the incompletetimeout property.

See Also:

Constant Field Values

PROPERTY_MAX_SPEECH_TIMEOUT

public static final java.lang.String PROPERTY_MAX_SPEECH_TIMEOUT

Name of the maxspeechtimeout property.

See Also:

Constant Field Values

DEFAULT_CONFIDENCE_LEVEL

public static final float DEFAULT_CONFIDENCE_LEVEL

The default confidence level.

See Also:

Constant Field Values

DEFAULT_SENSITIVITY

public static final float DEFAULT_SENSITIVITY

The default sensitivity.

See Also:

Constant Field Values

DEFAULT_SPEED_VS_ACCURACY

public static final float DEFAULT_SPEED_VS_ACCURACY

The default balance between speed vs. accuracy.

See Also:

Constant Field Values

Constructor Detail

SpeechRecognizerProperties

public SpeechRecognizerProperties()

Constructs a new object.

Method Detail

setProperties

public final void setProperties(java.util.Map<java.lang.String,java.lang.String> props)

Retrieves the speech recognizer properties from the given map.

Parameters:

props - map with current properties

setEnhancedProperties

protected void setEnhancedProperties(java.util.Map<java.lang.String,java.lang.String> props)

May be used to set custom properties if this class is extended.

Parameters:

props - map with current properties.

getConfidencelevel

public final float getConfidencelevel()

Retrieves the confidence level.

Returns:

the confidence level

setConfidencelevel

public final void setConfidencelevel(float value)

Sets the confidence level.

Parameters:

value - the confidence level to set

getSensitivity

public final float getSensitivity()

Retrieves the sensitivity.

Returns:

the sensitivity

setSensitivity

public final void setSensitivity(float value)

Sets the sensitivity.

Parameters:

value - the sensitivity to set

getSpeedvsaccuracy

public final float getSpeedvsaccuracy()

Retrieves a hint specifying the desired balance between speed vs. accuracy.

Returns:

the speedvsaccuracy

setSpeedvsaccuracy

public final void setSpeedvsaccuracy(float value)

Sets the hint specifying the desired balance between speed vs. accuracy.

Parameters:

value - the speedvsaccuracy to set

getCompletetimeoutAsMsec

public final long getCompletetimeoutAsMsec()

Retrieves the length of silence required following user speech before the speech recognizer finalizes a result.

Returns:

the completetimeout

setCompletetimeout

public final void setCompletetimeout(java.lang.String value)

Sets the length of silence required following user speech before the speech recognizer finalizes a result.

Parameters:

value - the complete timeout to set as a time designitation

getIncompletetimeoutAsMsec

public final long getIncompletetimeoutAsMsec()

Retrieves the required length of silence following user speech after which a recognizer finalizes a result.

Returns:

the incomplete timeout

setIncompletetimeout

public final void setIncompletetimeout(java.lang.String value)

Sets the required length of silence following user speech after which a recognizer finalizes a result.

Parameters:

value - the incomplete timeout to set as a time designation

getMaxspeechtimeoutAsMsec

public final long getMaxspeechtimeoutAsMsec()

/* Retrieves the maximum duration of user speech.

Returns:

the max speech timeout

setMaxspeechtimeout

public final void setMaxspeechtimeout(java.lang.String value)

/* Sets the maximum duration of user speech.

Parameters:

value - the max speech timeout to set as a time designation