ssml:speak Element

Switch View :
ScriptFree
Speech Server
ssml:speak Element

The required root element of a Speech Synthesis Markup Language (SSML) document.

Syntax

<ssml:speak version="1.0" xmlns:ssml="http://www.w3.org/2001/10/synthesis" xml:lang="en-US"> </ssml:speak>
Attributes

Term Definition

version

Required. Indicates the version of the World Wide Web Consortium SSML specification used to interpret the document markup. The current version is 1.0.

xml:lang

Recommended. Specifies the language of the root document. Values supported by Speech Server are en-GB, de-DE, en-AU, en-US, es-ES, es-US, fr-CA, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, zh-CN, and zh-TW.

xmlns

Required. Specifies the URI to the document that defines the markup vocabulary (the element types and attribute names) of the SSML document.

The current URI is http://www.w3.org/2001/10/synthesis.

Remarks

Valid SSML documents must contain the root element ssml:speak. Documents that do not contain the root element ssml:speak are rejected by the Speech Server text-to-speech engine.

When Speech Controls play prompts, they automatically enclose prompt text elements within ssml:speak tags as needed. If the prompt text already contains ssml:speak tags, the resulting prompt fails to play. For this reason, the ssml:speak tag should not be used in the following types of text:

  • Text placed in the InlinePrompt property of the DialogPrompt Dialog Speech Control
  • Text returned by the PromptSelectFunction of the DialogPrompt Dialog Speech Control
Example

<?xml version="1.0" encoding="ISO-8859-1"?>
<ssml:speak version="1.0"
 xmlns:ssml="http://www.w3.org/2001/10/synthesis"
 xml:lang="en-US">

<ssml:paragraph>
This is the text that will be spoken by the application
</ssml:paragraph>

</ssml:speak>