org.jvoicexml

Class DtmfRecognizerProperties

java.lang.Object

org.jvoicexml.DtmfRecognizerProperties

public class DtmfRecognizerProperties
extends java.lang.Object

Generic DTMF recognizer properties as described in http://www.w3.org/TR/voicexml20#dml6.3.3. 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 char	DEFAULT_TERM_CHAR The default value for the terminating character.
static java.lang.String	DEFAULT_TERM_TIMEOUT The default value for the terminating timeout.
static java.lang.String	PROPERTY_INTERDIGIT_TIMEOUT Name of the interdigittimeout property.
static java.lang.String	PROPERTY_TERM_CHAR Name of the termchar property.
static java.lang.String	PROPERTY_TERM_TIMEOUT Name of the termtimeout property.

Constructor Summary

Constructors

Constructor and Description
DtmfRecognizerProperties() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
long	getInterdigittimeoutAsMsec() Retrieves the inter-digit timeout value to use when recognizing DTMF input.
char	getTermchar() Retrieves the terminating DTMF character for DTMF input recognition.
long	getTermtimeoutAsMsec() Retrieves the terminating timeout to use when recognizing DTMF input.
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	setInterdigittimeout(java.lang.String value) Sets the inter-digit timeout value to use when recognizing DTMF input.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> props) Retrieves the DTMF recognizer properties from the given map.
void	setTermchar(char value) Sets the terminating DTMF character for DTMF input recognition.
void	setTermtimeout(java.lang.String value) Sets the terminating timeout to use when recognizing DTMF input.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_INTERDIGIT_TIMEOUT

public static final java.lang.String PROPERTY_INTERDIGIT_TIMEOUT

Name of the interdigittimeout property.

See Also:

Constant Field Values

PROPERTY_TERM_TIMEOUT

public static final java.lang.String PROPERTY_TERM_TIMEOUT

Name of the termtimeout property.

See Also:

Constant Field Values

PROPERTY_TERM_CHAR

public static final java.lang.String PROPERTY_TERM_CHAR

Name of the termchar property.

See Also:

Constant Field Values

DEFAULT_TERM_TIMEOUT

public static final java.lang.String DEFAULT_TERM_TIMEOUT

The default value for the terminating timeout.

See Also:

Constant Field Values

DEFAULT_TERM_CHAR

public static final char DEFAULT_TERM_CHAR

The default value for the terminating character.

See Also:

Constant Field Values

Constructor Detail

DtmfRecognizerProperties

public DtmfRecognizerProperties()

Constructs a new object.

Method Detail

setProperties

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

Retrieves the DTMF recognizer properties from the given map.

Parameters:

props - map with current properties

Since:

0.7.5

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.

Since:

0.7.5

getInterdigittimeoutAsMsec

public final long getInterdigittimeoutAsMsec()

Retrieves the inter-digit timeout value to use when recognizing DTMF input.

Returns:

the inter-digit timeout

setInterdigittimeout

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

Sets the inter-digit timeout value to use when recognizing DTMF input.

Parameters:

value - the inter-digit timeout to set as a time designation

getTermtimeoutAsMsec

public final long getTermtimeoutAsMsec()

Retrieves the terminating timeout to use when recognizing DTMF input.

Returns:

the terminating timeout

setTermtimeout

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

Sets the terminating timeout to use when recognizing DTMF input.

Parameters:

value - the terminating timeout to set

getTermchar

public final char getTermchar()

Retrieves the terminating DTMF character for DTMF input recognition.

Returns:

the terminating DTMF character, maybe 0, if no terminating character has been defined

setTermchar

public final void setTermchar(char value)

Sets the terminating DTMF character for DTMF input recognition.

Parameters:

value - the terminating DTMF character to set