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
  • <audio>
  • Attributes
  • Notes
  • Example
  • Child Tags
  • Parent Tags
  1. VoiceXML
  2. Tags

<audio>

<audio>

Retrieves and plays the specified audio file. If the audio file is unavailable, any enclosed text is sent to the TTS engine for speech synthesis instead.

Attributes

Name
Data type
Description

src

String

expr

String

The expression may be either a reference to audio previously recorded with the item or evaluate to the URI of an audio resource to fetch.

stream

String

The URI of an audio stream to play. Any queued audio is immediately cleared if an MP3 audio stream is opened.

fetchhint

This attribute is not supported.

fetchtimeout

String

(defaults to “fetchtimeout” global property value) The timeout for fetches. Must be specified with the appropriate time units (e.g., “120s” for 120 seconds).

maxage

String

(defaults to “audiomaxage” global property value) Tells the platform the maximum acceptable age, in seconds, of cached audio resources.

maxstale

String

(defaults to “audiomaxstale” global property value) Tells the platform the maximum acceptable staleness, in seconds, of expired cached audio resources.

maxtime

String

(defaults to unlimited) The maximum number of seconds of the audio prompt to play.

starttime

String

(defaults to “0s”) The number of seconds into the referenced audio prompt at which to begin playback.

Notes

The setting for the “src” attribute has priority over the setting for the “expr” attribute. If the wave file at the location specified by the “src” attribute can not be retrieved, the text within the “audio” tag will be read by the TTS engine.

Example

<?xml version="1.0"?>
<vxml version="2.0">
  <form>
    <block>
      <prompt>
        I'm going to play an audio file.
      </prompt>
      <audio src="http://nonexistent.domain.com/test.wav">
        Oops, the audio file could not be retrieved!
      </audio>
    </block>
  </form>
</vxml>

The output of the above script would be:

Computer: I'm going to play an audio file. Computer: (plays audio file if available)

Child Tags

Parent Tags

Previous<assign>Next<block>

Last updated 1 year ago

The URI of the audio prompt. See for supported audio formats.

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

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

<audio>
<break>
<desc>
<emphasis>
<enumerate>
<mark>
<p>
<paragraph>
<phoneme>
<prosody>
<say-as>
<sentence>
<speak>
<sub>
<value>
<voice>
<audio>
<block>
<catch>
<emphasis>
<enumerate>
<error>
<field>
<filled>
<foreach>
<help>
<if>
<initial>
<menu>
<noinput>
<nomatch>
<paragraph>
<prompt>
<prosody>
<record>
<sentence>
<speak>
<subdialog>
<transfer>
<voice>
here