Prosody (org.jvoicexml.xml 0.7.8 API)

java.lang.Object
- org.jvoicexml.xml.AbstractXmlNode
- - org.jvoicexml.xml.ssml.Prosody

All Implemented Interfaces:

SsmlNode, TextContainer, VoiceXmlNode, XmlNode, org.w3c.dom.Node
```
public final class Prosody
extends AbstractXmlNode
implements VoiceXmlNode, TextContainer
```
The prosody element permits control of the pitch, speaking rate and volume of the speech output.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE_CONTOUR` Sets the actual pitch contour for the contained text.
`static java.lang.String`	`ATTRIBUTE_DURATION` A value in seconds or milliseconds for the desired time to take to read the element contents.
`protected static java.util.ArrayList<java.lang.String>`	`ATTRIBUTE_NAMES` Supported attribute names for this node.
`static java.lang.String`	`ATTRIBUTE_PITCH` The baseline pitch for the contained text.
`static java.lang.String`	`ATTRIBUTE_RANGE` The pitch range (variability) for the contained text.
`static java.lang.String`	`ATTRIBUTE_RATE` A change in the speaking rate for the contained text.
`static java.lang.String`	`ATTRIBUTE_VOLUME` The volume for the contained text in the range 0.0 to 100.0 (higher values are louder and specifying a value of zero is equivalent to specifying "silent").
`static java.lang.String`	`PITCH_DEFAULT` Pitch level `default`.
`static java.lang.String`	`PITCH_HIGH` Pitch level `high`.
`static java.lang.String`	`PITCH_LOW` Pitch level `low`.
`static java.lang.String`	`PITCH_MEDIUM` Pitch level `medium`.
`static java.lang.String`	`PITCH_X_HIGH` Pitch level `x-high`.
`static java.lang.String`	`PITCH_X_LOW` Pitch level `x-low`.
`static java.lang.String`	`RANGE_DEFAULT` Range level `default`.
`static java.lang.String`	`RANGE_HIGH` Range level `high`.
`static java.lang.String`	`RANGE_LOW` Range level `low`.
`static java.lang.String`	`RANGE_MEDIUM` Range level `medium`.
`static java.lang.String`	`RANGE_X_HIGH` Range level `x-high`.
`static java.lang.String`	`RANGE_X_LOW` Range level `x-low`.
`static java.lang.String`	`RATE_DEFAULT` Rate level `default`.
`static java.lang.String`	`RATE_FAST` Rate level `fast`.
`static java.lang.String`	`RATE_MEDIUM` Rate level `medium`.
`static java.lang.String`	`RATE_SLOW` Rate level `slow`.
`static java.lang.String`	`RATE_X_FAST` Rate level `x-fast`.
`static java.lang.String`	`RATE_X_SLOW` Rate level `x-slow`.
`static java.lang.String`	`TAG_NAME` Name of the tag.
`static java.lang.String`	`VOLUME_DEFAULT` Volume level `default`.
`static java.lang.String`	`VOLUME_LOUD` Volume level `loud`.
`static java.lang.String`	`VOLUME_MEDIUM` Volume level `medium`.
`static java.lang.String`	`VOLUME_SILENT` Volume level `silent`.
`static java.lang.String`	`VOLUME_SOFT` Volume level `soft`.
`static java.lang.String`	`VOLUME_X_LOUD` Volume level `x-loud`.
`static java.lang.String`	`VOLUME_X_SOFT` Volume level `x-soft`.

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

Prosody()
Construct a new prosody object without a node.

Constructors
Constructor and Description
`Prosody()` Construct a new prosody object without a node.

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getContour()` Retrieve the contour attribute.
`java.lang.String`	`getDuration()` Retrieve the duration attribute.
`java.lang.String`	`getPitch()` Retrieve the pitch attribute.
`float`	`getPitchFloat()` Retrieves the rate attribute as a float.
`java.lang.String`	`getRange()` Retrieve the range attribute.
`java.lang.String`	`getRate()` Retrieve the rate attribute.
`float`	`getRateFloat()` Retrieves the rate attribute as a float.
`java.lang.String`	`getTagName()` Get the name of the tag for the derived node.
`java.lang.String`	`getVolume()` Retrieve the volume attribute.
`XmlNode`	`newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory)` Create a new instance for the given node.
`void`	`setContour(java.lang.String contour)` Set the contour attribute.
`void`	`setDuration(java.lang.String duration)` Set the duration attribute.
`void`	`setPitch(float pitch)` Set the pitch attribute.
`void`	`setPitch(java.lang.String pitch)` Set the pitch attribute.
`void`	`setRange(java.lang.String range)` Set the range attribute.
`void`	`setRate(float rate)` Set the rate attribute.
`void`	`setRate(java.lang.String rate)` Set the rate attribute.
`void`	`setVolume(java.lang.String volume)` Set the volume 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_PITCH
```
public static final java.lang.String ATTRIBUTE_PITCH
```
    The baseline pitch for the contained text. Although the exact meaning of "baseline pitch" will vary across synthesis processors, increasing/decreasing this value will typically increase/decrease the approximate pitch of the output. Legal values are: a number followed by "Hz", a relative change or "x-low", "low", "medium", "high", "x-high", or "default". Labels "x-low" through "x-high" represent a sequence of monotonically non-decreasing pitch levels.
    
    See Also:
    
    Constant Field Values
  - PITCH_X_LOW
```
public static final java.lang.String PITCH_X_LOW
```
    Pitch level x-low.
    
    See Also:
    
    Constant Field Values
  - PITCH_LOW
```
public static final java.lang.String PITCH_LOW
```
    Pitch level low.
    
    See Also:
    
    Constant Field Values
  - PITCH_MEDIUM
```
public static final java.lang.String PITCH_MEDIUM
```
    Pitch level medium.
    
    See Also:
    
    Constant Field Values
  - PITCH_HIGH
```
public static final java.lang.String PITCH_HIGH
```
    Pitch level high.
    
    See Also:
    
    Constant Field Values
  - PITCH_X_HIGH
```
public static final java.lang.String PITCH_X_HIGH
```
    Pitch level x-high.
    
    See Also:
    
    Constant Field Values
  - PITCH_DEFAULT
```
public static final java.lang.String PITCH_DEFAULT
```
    Pitch level default.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_CONTOUR
```
public static final java.lang.String ATTRIBUTE_CONTOUR
```
    Sets the actual pitch contour for the contained text.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_RANGE
```
public static final java.lang.String ATTRIBUTE_RANGE
```
    The pitch range (variability) for the contained text. Although the exact meaning of "pitch range" will vary across synthesis processors, increasing/decreasing this value will typically increase/decrease the dynamic range of the output pitch. Legal values are: a number followed by "Hz", a relative change or "x-low", "low", "medium", "high", "x-high", or "default". Labels "x-low" through "x-high" represent a sequence of monotonically non-decreasing pitch ranges.
    
    See Also:
    
    Constant Field Values
  - RANGE_X_LOW
```
public static final java.lang.String RANGE_X_LOW
```
    Range level x-low.
    
    See Also:
    
    Constant Field Values
  - RANGE_LOW
```
public static final java.lang.String RANGE_LOW
```
    Range level low.
    
    See Also:
    
    Constant Field Values
  - RANGE_MEDIUM
```
public static final java.lang.String RANGE_MEDIUM
```
    Range level medium.
    
    See Also:
    
    Constant Field Values
  - RANGE_HIGH
```
public static final java.lang.String RANGE_HIGH
```
    Range level high.
    
    See Also:
    
    Constant Field Values
  - RANGE_X_HIGH
```
public static final java.lang.String RANGE_X_HIGH
```
    Range level x-high.
    
    See Also:
    
    Constant Field Values
  - RANGE_DEFAULT
```
public static final java.lang.String RANGE_DEFAULT
```
    Range level default.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_RATE
```
public static final java.lang.String ATTRIBUTE_RATE
```
    A change in the speaking rate for the contained text. Legal values are: a relative change or "x-slow", "slow", "medium", "fast", "x-fast", or "default". Labels "x-slow" through "x-fast" represent a sequence of monotonically non-decreasing speaking rates. When a number is used to specify a relative change it acts as a multiplier of the default rate. For example, a value of 1 means no change in speaking rate, a value of 2 means a speaking rate twice the default rate, and a value of 0.5 means a speaking rate of half the default rate. The default rate for a voice depends on the language and dialect and on the personality of the voice. The default rate for a voice should be such that it is experienced as a normal speaking rate for the voice when reading aloud text. Since voices are processor-specific, the default rate will be as well.
    
    See Also:
    
    Constant Field Values
  - RATE_X_SLOW
```
public static final java.lang.String RATE_X_SLOW
```
    Rate level x-slow.
    
    See Also:
    
    Constant Field Values
  - RATE_SLOW
```
public static final java.lang.String RATE_SLOW
```
    Rate level slow.
    
    See Also:
    
    Constant Field Values
  - RATE_MEDIUM
```
public static final java.lang.String RATE_MEDIUM
```
    Rate level medium.
    
    See Also:
    
    Constant Field Values
  - RATE_FAST
```
public static final java.lang.String RATE_FAST
```
    Rate level fast.
    
    See Also:
    
    Constant Field Values
  - RATE_X_FAST
```
public static final java.lang.String RATE_X_FAST
```
    Rate level x-fast.
    
    See Also:
    
    Constant Field Values
  - RATE_DEFAULT
```
public static final java.lang.String RATE_DEFAULT
```
    Rate level default.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_DURATION
```
public static final java.lang.String ATTRIBUTE_DURATION
```
    A value in seconds or milliseconds for the desired time to take to read the element contents. Follows the time value format from the Cascading Style Sheet Level 2 Recommendation, e.g. "250ms", "3s".
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_VOLUME
```
public static final java.lang.String ATTRIBUTE_VOLUME
```
    The volume for the contained text in the range 0.0 to 100.0 (higher values are louder and specifying a value of zero is equivalent to specifying "silent"). Legal values are: number, a relative change or "silent", "x-soft", "soft", "medium", "loud", "x-loud", or "default". The volume scale is linear amplitude. The default is 100.0. Labels "silent" through "x-loud" represent a sequence of monotonically non-decreasing volume levels.
    
    See Also:
    
    Constant Field Values
  - VOLUME_SILENT
```
public static final java.lang.String VOLUME_SILENT
```
    Volume level silent.
    
    See Also:
    
    Constant Field Values
  - VOLUME_X_SOFT
```
public static final java.lang.String VOLUME_X_SOFT
```
    Volume level x-soft.
    
    See Also:
    
    Constant Field Values
  - VOLUME_SOFT
```
public static final java.lang.String VOLUME_SOFT
```
    Volume level soft.
    
    See Also:
    
    Constant Field Values
  - VOLUME_MEDIUM
```
public static final java.lang.String VOLUME_MEDIUM
```
    Volume level medium.
    
    See Also:
    
    Constant Field Values
  - VOLUME_LOUD
```
public static final java.lang.String VOLUME_LOUD
```
    Volume level loud.
    
    See Also:
    
    Constant Field Values
  - VOLUME_X_LOUD
```
public static final java.lang.String VOLUME_X_LOUD
```
    Volume level x-loud.
    
    See Also:
    
    Constant Field Values
  - VOLUME_DEFAULT
```
public static final java.lang.String VOLUME_DEFAULT
```
    Volume level default.
    
    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
  - Prosody
```
public Prosody()
```
    Construct a new prosody 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
  - 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.
  - getPitch
```
public java.lang.String getPitch()
```
    Retrieve the pitch attribute.
    
    Returns:
    
    Value of the pitch attribute.
    
    See Also:
    
    ATTRIBUTE_PITCH
  - getPitchFloat
```
public float getPitchFloat()
```
    Retrieves the rate attribute as a float.
    
    Returns:
    
    Value of the rate attribute, 100 if the rate is not configured.
    
    Since:
    
    0.7.2
    
    See Also:
    
    ATTRIBUTE_RATE
  - setPitch
```
public void setPitch(java.lang.String pitch)
```
    Set the pitch attribute.
    
    Parameters:
    
    pitch - Value of the pitch attribute.
    
    See Also:
    
    ATTRIBUTE_PITCH
  - setPitch
```
public void setPitch(float pitch)
```
    Set the pitch attribute.
    
    Parameters:
    
    pitch - Value of the pitch attribute in Hertz.
    
    Since:
    
    0.7.2
    
    See Also:
    
    ATTRIBUTE_PITCH
  - getContour
```
public java.lang.String getContour()
```
    Retrieve the contour attribute.
    
    Returns:
    
    Value of the contour attribute.
    
    See Also:
    
    ATTRIBUTE_CONTOUR
  - setContour
```
public void setContour(java.lang.String contour)
```
    Set the contour attribute.
    
    Parameters:
    
    contour - Value of the contour attribute.
    
    See Also:
    
    ATTRIBUTE_CONTOUR
  - getRange
```
public java.lang.String getRange()
```
    Retrieve the range attribute.
    
    Returns:
    
    Value of the range attribute.
    
    See Also:
    
    ATTRIBUTE_RANGE
  - setRange
```
public void setRange(java.lang.String range)
```
    Set the range attribute.
    
    Parameters:
    
    range - Value of the range attribute.
    
    See Also:
    
    ATTRIBUTE_RANGE
  - getRate
```
public java.lang.String getRate()
```
    Retrieve the rate attribute.
    
    Returns:
    
    Value of the rate attribute.
    
    See Also:
    
    ATTRIBUTE_RATE
  - getRateFloat
```
public float getRateFloat()
```
    Retrieves the rate attribute as a float.
    
    Returns:
    
    Value of the rate attribute, 100 if the rate is not configured.
    
    Since:
    
    0.7.2
    
    See Also:
    
    ATTRIBUTE_RATE
  - setRate
```
public void setRate(java.lang.String rate)
```
    Set the rate attribute.
    
    Parameters:
    
    rate - Value of the rate attribute.
    
    See Also:
    
    ATTRIBUTE_RATE
  - setRate
```
public void setRate(float rate)
```
    Set the rate attribute.
    
    Parameters:
    
    rate - Value of the rate attribute.
    
    Since:
    
    0.7.2
    
    See Also:
    
    ATTRIBUTE_RATE
  - getDuration
```
public java.lang.String getDuration()
```
    Retrieve the duration attribute.
    
    Returns:
    
    Value of the duration attribute.
    
    See Also:
    
    ATTRIBUTE_DURATION
  - setDuration
```
public void setDuration(java.lang.String duration)
```
    Set the duration attribute.
    
    Parameters:
    
    duration - Value of the duration attribute.
    
    See Also:
    
    ATTRIBUTE_DURATION
  - getVolume
```
public java.lang.String getVolume()
```
    Retrieve the volume attribute.
    
    Returns:
    
    Value of the volume attribute.
    
    See Also:
    
    ATTRIBUTE_VOLUME
  - setVolume
```
public void setVolume(java.lang.String volume)
```
    Set the volume attribute.
    
    Parameters:
    
    volume - Value of the volume attribute.
    
    See Also:
    
    ATTRIBUTE_VOLUME
  - 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

Class Prosody

Field Summary

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

Methods inherited from class java.lang.Object

Methods inherited from interface org.jvoicexml.xml.TextContainer

Methods inherited from interface org.jvoicexml.xml.XmlNode

Methods inherited from interface org.w3c.dom.Node

Field Detail

TAG_NAME

ATTRIBUTE_PITCH

PITCH_X_LOW

PITCH_LOW

PITCH_MEDIUM

PITCH_HIGH

PITCH_X_HIGH

PITCH_DEFAULT

ATTRIBUTE_CONTOUR

ATTRIBUTE_RANGE

RANGE_X_LOW

RANGE_LOW

RANGE_MEDIUM

RANGE_HIGH

RANGE_X_HIGH

RANGE_DEFAULT

ATTRIBUTE_RATE

RATE_X_SLOW

RATE_SLOW

RATE_MEDIUM

RATE_FAST

RATE_X_FAST

RATE_DEFAULT

ATTRIBUTE_DURATION

ATTRIBUTE_VOLUME

VOLUME_SILENT

VOLUME_X_SOFT

VOLUME_SOFT

VOLUME_MEDIUM

VOLUME_LOUD

VOLUME_X_LOUD

VOLUME_DEFAULT

ATTRIBUTE_NAMES

Constructor Detail

Prosody

Method Detail

getTagName

newInstance

addText

getPitch

getPitchFloat

setPitch

setPitch

getContour

setContour

getRange

setRange

getRate

getRateFloat

setRate

setRate

getDuration

setDuration

getVolume

setVolume

canContainChild

getAttributeNames