<prompt>

Plays audio or synthesized speech.

A <prompt> element may contain one or more SSML elements.

Attributes

This section describes the attributes you can set for this element.

Name	Data type	Default
bargein	(true | false)	optional
bargeintype	(speech | hotword | selective)	optional
cond	CDATA	optional
count	CDATA	optional
ssft-domaintype	CDATA	optional
timeout	CDATA	optional
xml:lang	NMTOKENS	optional
xml:base	The browser interprets the value as a URI Reference as defined in RFC 2396 [IETF RFC 2396]	optional

bargein

Allows callers to interrupt audio contained within a prompt. If the bargein attribute is set to true (the default), any speech or DTMF detected during the prompt will stop prompt playback and immediately proceed to recognition or recording. If the bargein attribute is set to false, user input is ignored until the prompt is complete.

bargeintype

The type of interruption that will trigger the barge-in function:

• speech—The system detects any user input (voice or DTMF) and terminates the prompt, while sending the speech to the recognizer.
• selective (Nuance extension)—The system only interrupts the prompt if it recognizes a specific word, which must be spoken separately from the rest of the conversation (after a pause greater than the current incompletetimeout value).
• hotword—Like selective, except that an additional duration constraint is applied to the word before it is sent for recognition.

The default value is speech.

The difference between the hotword and selective types is that in a hotword barge-in, the word triggering the barge-in must fit within minimum and maximum durations specified using the swirec.swiep_magic_word_max_msec and swirec.swiep_magic_word_min_msec properties in the VoiceXML document. In a selective barge-in, no such limits are applied to the hotword. It can be a longer word, or even an entire phrase.

cond

A Boolean expression. The cond attribute must evaluate to true for the prompt to be played.

count

The relative ordering of prompts within a field-item. (The default is 1.) Note that the count attribute is not valid outside of a field-item. The selected prompts for a particular recognition or recording state, will be the set of prompts with the highest count which has not exceeded the number of times that particular state is reached. The internal counter, which keeps track of how many times a particular state is reached, is reset to 1 each time the enclosing <form> element is reached or a <clear> element (for that state) is encountered.

ssft-domaintype

This Nuance extension activates implicit matching for an ActivePrompt domain starting at the beginning of the text. The value is the ActivePrompt domain name.

timeout

The number of seconds of allowed user silence after a prompt is played. If the user does not speak within the specified amount of time, a <noinput> event is thrown. The <prompt> element's timeout attribute takes precedence over any timeout value specified within a property. The actual value of the timeout attribute is set according to the VoiceXML standard for specifying time.

xml:lang

The language and locale of the document using an identifier compliant with RFC 1766. If the xml:lang attribute is not specified, the default Java Virtual Machine locale is used. The value of the xml:lang attribute is defined as:

lang_value = language [DELIMITER country]

DELIMITER = "-"

language = <ISO-639 language code>

country = <ISO-3166 country code>

For example, some valid specifications of the xml:lang attribute are: 

fr French

en-US American English

It is possible to specify any valid RFC-1766 language code in the xml:lang attribute.

Refer to Localizing your deployment for information on constructing locales and localizing the Voice Browser service. 

xml:base

The base URL for resolving relative paths. Use this attribute to override the base of the VoiceXML document (see File header).

Children

• Parsed character data (rendered using text-to-speech)
• <audio>
• <enumerate>
• <foreach>
• <value>

Parents

• <block>
• <catch>
• <error>
• <field>
• <filled>
• <foreach>
• <help>
• <if>
• <initial>
• <menu>
• <noinput>
• <nomatch>
• <record>
• <subdialog>
• <transfer>

Sample code

<form id="login">

    <field name="id_number">

        <grammar src="../grammars/login.grxml"/>

        <prompt> Please state your login identification.</prompt>

        <prompt count="2"> Please state your login identification.

            To open a new account, say: new account.</prompt>

    </field>

    <catch event="noinput nomatch"/> 

    I'm sorry. I didn't catch that.

        </reprompt>

    </catch>

</form>

For a VoiceXML sample demonstrating the use of the <prompt> element within a multi-lingual application, see the UnitedNations applications located in $NVP_HOME/appservice/applications/webapps/UnitedNations.