====== Properties ======

Properties are used to set values that affect platform behavior.  Properties apply to their parent element and all the descendants of the parent.  A property at a lower level overrides a property at a higher level.  Additional properties are supported with Call Control extensions.

===== DTMF Recognition Properties =====

The following are the DTMF recognition properties:

**interdigittimeout**

This property indicates the timeout period allowed between each digit when recognizing DTMF input. The default is 3 seconds.

**termtimeout**

This  property determines the terminating timeout to use when recognizing DTMF input.  Allows entering the optional termchar. The default is 0 seconds.

**termchar**

This property is the terminating DTMF character for DTMF input recognition. The default is #.

===== Speech Recognition Properties =====

The following are the speech recognition properties:

**confidencelevel**

This property defines the threshold of the speech recognition confidence level.  Values range from 0.0 (minimum confidence) to 1.0 (maximum confidence). User inputs are ignored if the confidence level is below this threshold. The default is 0.5.

**sensitivity**

The sensitivity property defines the sensitivity level to input.  Values range from 0.0 (the least sensitive to background noise) to 1.0 (highly sensitive to noise input). The default is 0.5.

**completetimeout**

This property indicates the length of silence required following user speech, before the speech recognizer finalizes a result, either accepting it or throwing a nomatch event. The complete timeout is used when the speech result is a complete match of an active grammar. The default is 1 second.

**incompletetimeout**

The incompletetimeout property is used when the speech is an incomplete match to an active grammar. The default is 1 second.

**maxspeechtimeout**

The maxspeechtimeout property is the maximum duration of user speech.  If the time designated has elapsed before the user stops speaking, the maxspeechtimeout event is thrown. The default is 0 and indicates no limit.

**maxnbest**

The maxnbest property is the maximum number of N-Best results returned by the recognizer.  This also represents the maximum size of the application.lastresult$[i] array.

===== Prompt and Collect Properties =====

The following are the prompt and collect properties:

**inputmodes**

The input modes determines which input methods to use. The value is a space-separated list of input methods.

The default is dtmf voice:

    * “dtmf” - allows DTMF sequences as input.
    * “voice” - allows voice as input.

**timeout**

The timeout is the time after which the interpreter throws a noinput event. This property is not used in DTMF interactions. The default is 10 seconds.

**universals**

The universals property specifies universal commands.  The value is a space-separated list of the following commands.  You can designate none for nothing or all for all 3 commands.

This property is not supported yet.

    * cancel - throws the cancel event.
    * exit - throws the exit event.
    * help - throws the help event.

**bargein**

Enables user input during prompts if set to true. No barge-in if set to false. The default is true.

**bargeintype**

The bargeintype property specifies the barge-in type listed below.

This property is not supported yet.

    * energy - any noise can barge in the prompt.
    * speech - any user utterance can barge in the prompt.
    * recognition - only barge-in on the prompt when the user input matches a speech grammar.

===== Fetching Properties =====

The following are the fetching properties:

**audiofetchhint**

This property defines when audio files can be fetched:

    * prefetch – the file can be fetched when the document is loaded.
    * safe – the file is fetched only when needed, never before prefetch.

**audiomaxage**

This property defines the maximum acceptable age, in seconds, of cached audio resources.

**audiomaxstale**

Use this property to define the maximum staleness, in seconds, of expired cached audio resources.

**promptmaxage**

Promptmax age defines the maximum acceptable age, in seconds, of cached TTS audio resources.

**promptmaxstale**

This property defines the maximum staleness, in seconds, of expired cached TTS audio resources.

**documentfetchhint**

The documentfetchhint defines when a document can be fetched:

    * prefetch – the file can be fetched when the document is loaded.
    * safe – the file is fetched only when needed, never before prefetch.

**documentmaxage**

This property defines the maximum acceptable age, in seconds, of cached documents.

**documentmaxstale**

Documentmaxstale defines the maximum staleness, in seconds, of expired cached documents.

**grammarfetchhint**

This property defines when grammar files can be fetched.

This property is not supported yet.

    * prefetch – the file can be fetched when the document is loaded.
    * safe - the file is fetched only when needed, never before prefetch.

**grammarmaxage**

This defines the maximum acceptable age, in seconds, of cached grammar resources.

This property is not supported yet.

**grammarmaxstale**

Grammarmaxstyle defines maximum staleness, in seconds, of expired cached grammar resources.

This property is not supported yet.

**objectfetchhint**

This property defines when objects can be fetched:

    * prefetch - the file can be fetched when the document is loaded.
    * safe - the file is fetched only when needed, never before prefetch.

**objectmaxage**

Objectmax age defines the maximum acceptable age, in seconds, of cached object resources.

**objectmaxstale**

This property defines the maximum staleness, in seconds, of expired cached object resources.

**scriptfetchhint**

The scriptfetchhint property defines when script files can be fetched:

    * prefetch - the file can be fetched when the document is loaded.
    * safe - the file is fetched only when needed, never before prefetch.

**scriptmaxage**

This property defines the maximum acceptable age, in seconds, of cached script resources.

**scriptmaxstale**

This property defines the maximum staleness, in seconds, of expired cached script resources.

**fetchaudio**

Fetchaudiodefines the URI of audio to play while waiting for a document to be fetched.

**fetchtimeout**

This property defines the timeout for fetches. The default is 7.

===== Platform Properties =====

The following properties are specific to the Voximal VoiceXML browser platform and they are useful for debugging purposes. This property is not yet available.