<speak>

Top-level element required in a standalone SSML document.

Syntax

<speak
    version = "CDATA"
    xml:base = "URI"
    xml:lang = "CDATA"
    xmlns = "CDATA"
    xmlns:xsi = "CDATA"
    xsi:schemalocation = "CDATA"
     />

Attributes

Attribute

Data Type

Required?

Default

Description

version

CDATA

yes

NA

VoiceXML version.

xml:base

URI

no

NA

Base URI, used to resolve relative URIs in the document.

xml:lang

CDATA

no

NA

Language variant of the document.

xmlns

CDATA

no

NA

Designated namespace for VoiceXML.

xmlns:xsi

CDATA

no

NA

Used with the xsi:schemalocation attribute to indicate the location of the schema for the VoiceXML namespace.

xsi:schemalocation

CDATA

no

NA

Used with the xmlns:xsi attribute to indicate the location of the schema for the VoiceXML namespace.

Details

In-line SSML fragments are permitted in VoiceXML 2.0 documents. In this case, the <prompt> element is used in place of the <speak> element, allowing the same SSML child elements and attributes, except xmlns, xmlns:xsi, and xsi:schemaLocation.

The <speak> element describes how the enclosed text should be spoken. Whether or not a certain element has an effect depends on the capabilities of the TTS engine in use. In some cases, only certain attributes of an element have an effect, and even then, the level of control may not be as high as described in the specification.

For information about the elements and attributes supported by the current set of TTS engines, see SSML Support.

Parents

None.

Children

<audio>, <break>, <emphasis>, <mark>, <phoneme>, <p>, <prosody>, <s>, <say-as>, <sub>, <voice>

Example

<?xml version="1.0"?>
<vxml version="2.1" xmlns="http://www.w3.org/2001/vxml">
    <var name="num_messages" expr="3"/>
    <form>
        <block>
            <media type="application/ssml+xml">
                <speak version="1.0" xml:lang="en-GB">
                    Welcome to your Video Mail account!
                    You have <value expr="num_messages"/> messages.
                </speak>
            </media>
        </block>
    </form>
</vxml>

See Also

<prompt>