LogoLogo
  • Go to Docs Center
  • Plum DEV Documentation
  • Overview
  • Developer Reference
    • Tutorial
    • How to...
      • Use Plum's Transcription API
    • Audio Formats and Prompts
    • Grammars and Speech Recognition
    • Available ASR Engines
    • TTS Engine Characteristics
      • Amazon Polly TTS Engine
        • Polly Voice Tag Attribute Details
      • AT&T Natural Voices
      • Cepstral Engine
      • RealSpeak Engine
      • Vocalizer 7
        • Vocalizer 7: <voice> tag and SSML Support
    • Data Exchange
    • Logging
    • Caching
    • Root Documents
  • VoiceXML
    • Tags
      • <assign>
      • <audio>
      • <block>
      • <break>
      • <catch>
      • <choice>
      • <clear>
      • <data>
      • <desc>
      • <disconnect>
      • <else>
      • <elseif>
      • <emphasis>
      • <enumerate>
      • <error>
      • <example>
      • <exit>
      • <field>
      • <filled>
      • <foreach>
      • <form>
      • <goto>
      • <grammar>
      • <help>
      • <if>
      • <initial>
      • <item>
      • <lexicon>
      • <link>
      • <log>
      • <mark>
      • <menu>
      • <meta>
      • <metadata>
      • <noinput>
      • <nomatch>
      • <one-of>
      • <option>
      • <paragraph>
      • <param>
      • <phoneme>
      • <prompt>
      • <property>
      • <prosody>
      • <record>
      • <reprompt>
      • <return>
      • <rule>
      • <ruleref>
      • <say-as>
      • <script>
      • <sentence>
      • <speak>
      • <sub>
      • <subdialog>
      • <submit>
      • <tag>
      • <throw>
      • <token>
      • <transfer>
      • <value>
      • <var>
      • <voice>
      • <vxml>
    • Properties
      • audiofetchhint
      • audiomaxage
      • audiomaxstale
      • bargein
      • bargeintype
      • certverifypeer
      • completetimeout
      • confidencelevel
      • datafetchhint
      • datamaxage
      • datamaxstale
      • documentfetchhint
      • documentmaxage
      • documentmaxstale
      • fetchaudio
      • fetchaudiodelay
      • fetchaudiominimum
      • fetchtimeout
      • grammarfetchhint
      • grammarmaxage
      • grammarmaxstale
      • incompletetimeout
      • inputmodes
      • interdigittimeout
      • logging
      • maxnbest
      • maxspeechtimeout
      • normalizeaudio
      • recordcall
      • recordcallappend
      • recordutterance
      • recordutterancetype
      • scriptfetchhint
      • scriptmaxage
      • scriptmaxstale
      • sensitivity
      • speedvsaccuracy
      • termchar
      • termmaxdigits
      • termtimeout
      • timeout
      • universals
      • voicegender
      • voicename
    • Application and Session Variables
      • application.lastresult$[i].confidence
      • application.lastresult$[i].inputmode
      • application.lastresult$[i].interpretation
      • application.lastresult$[i].recording
      • application.lastresult$[i].recordingduration
      • application.lastresult$[i].recordingsize
      • application.lastresult$[i].utterance
      • session.callrecording
      • session.id
      • session.telephone.ani
      • session.telephone.dnis
    • VoiceXML Resources
  • Plum DEV Guide
    • Using the Plum DEV site
    • Using the File Repository
    • Outbound Calling Guide
      • Using the Outbound Tools in the DEV web UI
      • DEV Outbound Programming Notes
      • Outbound FAQs and Tips
    • Call Reporting
    • Analytics
    • VoiceTrends
    • Debugging
    • Scratchpads
    • Saved URLs
    • Voice Biometrics
    • Call Routing
    • Data Security
      • 'Private' Tags
      • Managing Secure Phone Numbers
      • Sensitive Data Types
    • SMS Guide
      • Standard Short Codes
      • SMS Debugging/Error Logs
      • Additional SMS Info
    • Single Sign On
  • Plum DEV APIs
    • DEV Outbound APIs
      • Contacts CSV Formatting
      • Outbound API Parameter Notes
      • Legacy and Miscellaneous Notes
    • SMS API
    • Call Logs API
    • Call Scheduling and Pacing API
    • Transcription API
    • Application API
    • Blocklist API
Powered by GitBook
On this page
  • <prosody>
  • Attributes
  • Notes
  • Example
  • Child Tags
  • Parent Tags
  1. VoiceXML
  2. Tags

<prosody>

<prosody>

The <prosody> tag changes the sound characteristics of the text being spoken.

Attributes

Name
Data type
Description

pitch

String

(defaults to “default”) The “pitch” attribute of the <prosody> tag changes the pitch of the spoken text. You can specify the following preset pitches: “high”, “medium”, “low”, or “default”.

Note: This attribute is available with the Cepstral Theta TTS engine only.

contour

This attribute is not supported.

range

This attribute is not supported.

rate

String

(defaults to “default”) The “rate” attribute of the <prosody> tag changes the rate at which the text is spoken. You can specify the following preset rates: “fast”, “medium”, “slow”, or “default”.

The rate attribute can also be set to an integer value such as “100.0” or “50.0”. A normal voice rate should be set to around “150.0” (for AT&T Natural Voices). These values are not in accordance with the SSML spec, where rates are specified relative to 1.

Additionally, you can also adjust the voice rate by using percentages. For example, entering “+50%” would make the voice rate 50% faster. SImilarly, entering “-50%” would make the voice rate 50% slower.

duration

This attribute is not supported.

volume

String

(defaults to “default”) The “volume” attribute of the <prosody> tag allows the application to change the volume of the TTS voice. You can specify the following preset volumes: “silent”, “soft”, “medium”, “loud”, or “default”.

Also, the volume level can be set to an integer number such as “25.0” for a soft volume or “200.0” for a loud volume.

Notes

When using a Realspeak TTS voice, the talking speed of the TTS voice does not revert back to the normal speed after the tag has been used. To revert it back to normal, you must use the tag again with the attribute of “volume” set to “100.0” and the attribute of “rate” set to “default”.

Example

<?xml version="1.0"?>
<vxml version="2.0">
  <form>
    <block>
      <prompt>
        This sentence uses the default prosody settings.
        <prosody volume="25.0" rate="slow">
          This sentence is slow and quiet.
        </prosody>
        <prosody volume="200.0" rate="fast">
          This sentence is fast and loud.
        </prosody>
      </prompt>
    </block>
  </form>
</vxml>

The output of the above script would be:

Computer: This sentence uses the default prosody settings. Computer: (slowly and quietly) This sentence is slow and quiet. Computer: (quickly and loudly) This sentence is fast and loud.

Child Tags

Parent Tags

Previous<property>Next<record>

Last updated 1 year ago

, , , , , , , , , , , , ,

, , , , , , , , ,

<audio>
<break>
<emphasis>
<enumerate>
<mark>
<paragraph>
<phoneme>
<prosody>
<say-as>
<sentence>
<speak>
<sub>
<value>
<voice>
<audio>
<emphasis>
<enumerate>
<foreach>
<paragraph>
<prompt>
<prosody>
<sentence>
<speak>
<voice>