org.jvoicexml.xml.ssml

Class Audio

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.ssml.Audio

All Implemented Interfaces:

SsmlNode, TextContainer, VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Audio
extends AbstractXmlNode
implements VoiceXmlNode, TextContainer

Audio can be played in any prompt. The audio content can be specified via a URI, and in VoiceXML it can also be in an audio variable previously recorded.

<prompt>
Your recorded greeting is
<audio expr="greeting"/> To rerecord, press 1.
To keep it, press pound.
To return to the main menu press star M.
To exit press star, star X.
</prompt>

The <audio> element can have alternate content in case the audio sample is not available:

<prompt>
<audio src="welcome.wav">
<emphasis>Welcome </emphasis> to the Voice Portal.
</audio>
</prompt>

If the audio file cannot be played (e.g. 'src' referencing or 'expr' evaluating to an invalid URI, a file with an unsupported format, etc), the content of the audio element is played instead. The content may include text, speech markup, or another audio element. If the audio file cannot be played and the content of the audio element is empty, no audio is played and no error event is thrown.

If <audio> contains an 'expr' attribute evaluating to ECMAScript undefined, then the element, including its alternate content, is ignored. This allows a developer to specify <audio> elements with dynamically assigned content which, if the element is not required, can be ignored by assigning its 'expr' a null value.

See Also:

Form, Prompt

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_EXPR An ECMAScript expression which determines the source of the audio to be played.
static java.lang.String	ATTRIBUTE_FETCHHINT Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed.
static java.lang.String	ATTRIBUTE_FETCHTIMEOUT The interval to wait for the content to be returned before throwing an error.badfetch event.
static java.lang.String	ATTRIBUTE_MAXAGE Indicates that the document is willing to use content whose age is no greater than the specified time in seconds.
static java.lang.String	ATTRIBUTE_MAXSTALE Indicates that the document is willing to use content that has exceeded its expiration time.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_SRC The URI of the audio prompt.
static java.lang.String	TAG_NAME Name of the tag.

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor and Description
Audio() Construct a new audio object without a node.

Method Summary

Modifier and Type	Method and Description
Text	addText(java.lang.String text) Creates a new text within this node.
protected boolean	canContainChild(java.lang.String tagName) Can the specified sub-tag be contained within this node?
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getExpr() Retrieve the expr attribute.
java.lang.String	getFetchhint() Retrieve the fetchhint attribute.
java.lang.String	getFetchtimeout() Retrieve the fetchtimeout attribute.
java.lang.String	getMaxage() Retrieve the maxage attribute.
java.lang.String	getMaxstale() Retrieve the maxstale attribute.
java.lang.String	getSrc() Retrieve the src attribute.
java.net.URI	getSrcUri() Retrieves the src attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setExpr(java.lang.String expr) Set the expr attribute.
void	setFetchhint(java.lang.String fetchhint) Set the fetchhint attribute.
void	setFetchtimeout(java.lang.String fetchtimeout) Set the fetchtimeout attribute.
void	setMaxage(java.lang.String maxage) Set the maxage attribute.
void	setMaxstale(java.lang.String maxstale) Set the maxstale attribute.
void	setSrc(java.lang.String src) Sets the src attribute.
void	setSrc(java.net.URI src) Sets the src attribute.

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

addChild, addChild, appendChild, appendChild, appendDeepClone, cloneNode, compareDocumentPosition, equals, getAttribute, getAttributes, getBaseURI, getChildNodes, getChildNodes, getChildren, getDefinedAttributeNames, getFeature, getFirstChild, getFirstLevelTextContent, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeFactory, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerXmlDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttribute, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jvoicexml.xml.TextContainer

getNodeFactory

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getChildNodes, getChildren, getNode, setAttribute

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_SRC

public static final java.lang.String ATTRIBUTE_SRC

The URI of the audio prompt.

See Also:

Constant Field Values

ATTRIBUTE_FETCHTIMEOUT

public static final java.lang.String ATTRIBUTE_FETCHTIMEOUT

The interval to wait for the content to be returned before throwing an error.badfetch event. This defaults to the fetchtimeout property.

See Also:

Constant Field Values

ATTRIBUTE_FETCHHINT

public static final java.lang.String ATTRIBUTE_FETCHHINT

Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed. This defaults to the audiofetchhint property.

See Also:

Constant Field Values

ATTRIBUTE_MAXAGE

public static final java.lang.String ATTRIBUTE_MAXAGE

Indicates that the document is willing to use content whose age is no greater than the specified time in seconds. The document is not willing to use stale content, unless maxstale is also provided. This defaults to the audiomaxage property.

See Also:

Constant Field Values

ATTRIBUTE_MAXSTALE

public static final java.lang.String ATTRIBUTE_MAXSTALE

Indicates that the document is willing to use content that has exceeded its expiration time. If maxstale is assigned a value, then the document is willing to accept content that has exceeded its expiration time by no more than the specified number of seconds. This defaults to the audiomaxstale property.

See Also:

Constant Field Values

ATTRIBUTE_EXPR

public static final java.lang.String ATTRIBUTE_EXPR

An ECMAScript expression which determines the source of the audio to be played. The expression may be either a reference to audio previously recorded with the <record/> item or evaluate to the URI of an audio resource to fetch.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Audio

public Audio()

Construct a new audio object without a node.

This is necessary for the node factory.

See Also:

SsmlNodeFactory

Method Detail

getTagName

public java.lang.String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in interface XmlNode

Returns:

name of the tag.

newInstance

public XmlNode newInstance(org.w3c.dom.Node n,
                           XmlNodeFactory<? extends XmlNode> factory)

Create a new instance for the given node.

Each XmlNode can serve as a prototype in a XmlNodeFactory to produce a collection of child nodes. Factories can then use the prototype pattern to produce new nodes.

Specified by:

newInstance in interface XmlNode

Parameters:

n - The node to encapsulate.

factory - the factroy that calls this method.

Returns:

The new instance.

See Also:

XmlNodeFactory

getSrc

public java.lang.String getSrc()

Retrieve the src attribute.

Returns:

Value of the src attribute.

See Also:

ATTRIBUTE_SRC

getSrcUri

public java.net.URI getSrcUri()
                       throws java.net.URISyntaxException

Retrieves the src attribute.

Returns:

Value of the src attribute.

Throws:

java.net.URISyntaxException - Error converting the attribute to a URI.

Since:

0.6

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(java.lang.String src)

Sets the src attribute.

Parameters:

src - Value of the src attribute.

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(java.net.URI src)

Sets the src attribute.

Parameters:

src - Value of the src attribute.

Since:

0.6

See Also:

ATTRIBUTE_SRC

getFetchtimeout

public java.lang.String getFetchtimeout()

Retrieve the fetchtimeout attribute.

Returns:

Value of the fetchtimeout attribute.

See Also:

ATTRIBUTE_FETCHTIMEOUT

setFetchtimeout

public void setFetchtimeout(java.lang.String fetchtimeout)

Set the fetchtimeout attribute.

Parameters:

fetchtimeout - Value of the fetchtimeout attribute.

See Also:

ATTRIBUTE_FETCHTIMEOUT

getFetchhint

public java.lang.String getFetchhint()

Retrieve the fetchhint attribute.

Returns:

Value of the fetchhint attribute.

See Also:

ATTRIBUTE_FETCHHINT

setFetchhint

public void setFetchhint(java.lang.String fetchhint)

Set the fetchhint attribute.

Parameters:

fetchhint - Value of the fetchhint attribute.

See Also:

ATTRIBUTE_FETCHHINT

getMaxage

public java.lang.String getMaxage()

Retrieve the maxage attribute.

Returns:

Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

setMaxage

public void setMaxage(java.lang.String maxage)

Set the maxage attribute.

Parameters:

maxage - Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

getMaxstale

public java.lang.String getMaxstale()

Retrieve the maxstale attribute.

Returns:

Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

setMaxstale

public void setMaxstale(java.lang.String maxstale)

Set the maxstale attribute.

Parameters:

maxstale - Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

getExpr

public java.lang.String getExpr()

Retrieve the expr attribute.

Returns:

Value of the expr attribute.

See Also:

ATTRIBUTE_EXPR

setExpr

public void setExpr(java.lang.String expr)

Set the expr attribute.

Parameters:

expr - Value of the expr attribute.

See Also:

ATTRIBUTE_EXPR

canContainChild

protected boolean canContainChild(java.lang.String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class AbstractXmlNode

Parameters:

tagName - Name of child.

Returns:

True if the sub-tag is allowed on this node.

getAttributeNames

public java.util.Collection<java.lang.String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Specified by:

getAttributeNames in interface XmlNode

Overrides:

getAttributeNames in class AbstractXmlNode

Returns:

A collection of attribute names that are allowed for the node

addText

public Text addText(java.lang.String text)

Creates a new text within this node. If the last child node already is a text node the given trimmed text is appended to that node.

Specified by:

addText in interface TextContainer

Parameters:

text - The text to be added.

Returns:

The new created text.

Since:

0.6