org.jvoicexml

Class SpeakableSsmlText

java.lang.Object

org.jvoicexml.SpeakableSsmlText

All Implemented Interfaces:

SpeakableText

public final class SpeakableSsmlText
extends java.lang.Object
implements SpeakableText

Text to be passed to the TTS engine. This text may contain SSML markups, as defined in http://www.w3.org/TR/2003/CR-speech-synthesis-20031218/.

Since:

0.4

Constructor Summary

Constructors

Constructor and Description
SpeakableSsmlText(org.jvoicexml.xml.ssml.SsmlDocument doc) Constructs a new object.
SpeakableSsmlText(org.jvoicexml.xml.ssml.SsmlDocument doc, boolean useBargein, org.jvoicexml.xml.vxml.BargeInType type) Constructs a new object.
SpeakableSsmlText(java.lang.String text, java.util.Locale locale) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
SpeakableText	appendSpeakableText(java.lang.String str) Appends the given text to this speakable.
boolean	equals(java.lang.Object other)
org.jvoicexml.xml.vxml.BargeInType	getBargeInType() Retrieves the barge-in type.
org.jvoicexml.xml.ssml.SsmlDocument	getDocument() Retrieves the SSML document to speak.
java.lang.String	getSpeakableText() Retrieves the text to be passed to the TTS Engine.
long	getTimeout() Retrieves the timeout of this speakable to wait before a noinput event is generated.
int	hashCode()
boolean	isBargeInEnabled(org.jvoicexml.xml.vxml.BargeInType type) Checks is barge-in is enabled for this speakable and the given bargein type.
boolean	isSpeakableTextEmpty() Checks if this speakable contains any text to be passed to the TTS engine.
void	setTimeout(long msec) Sets the timeout that will be used for the following user input.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeakableSsmlText

public SpeakableSsmlText(java.lang.String text,
                         java.util.Locale locale)
                  throws javax.xml.parsers.ParserConfigurationException

Constructs a new object. The given text is encapsulated in an SsmlDocument.

Parameters:

text - the text that should be contained in the speakable

locale - the locale of this speakable

Throws:

javax.xml.parsers.ParserConfigurationException - error creating the SsmlDocument.

SpeakableSsmlText

public SpeakableSsmlText(org.jvoicexml.xml.ssml.SsmlDocument doc)

Constructs a new object.

Parameters:

doc - The SSML document to speak.

SpeakableSsmlText

public SpeakableSsmlText(org.jvoicexml.xml.ssml.SsmlDocument doc,
                         boolean useBargein,
                         org.jvoicexml.xml.vxml.BargeInType type)

Constructs a new object.

Parameters:

doc - the SSML document to speak.

useBargein - true if bargein is supported.

type - the barge-in type, maybe null if no bargein is supported.

Method Detail

getSpeakableText

public java.lang.String getSpeakableText()

Retrieves the text to be passed to the TTS Engine.

Specified by:

getSpeakableText in interface SpeakableText

Returns:

Text to be spoken.

getDocument

public org.jvoicexml.xml.ssml.SsmlDocument getDocument()

Retrieves the SSML document to speak.

Returns:

SSML document to speak.

Since:

0.5

appendSpeakableText

public SpeakableText appendSpeakableText(java.lang.String str)

Appends the given text to this speakable.

Specified by:

appendSpeakableText in interface SpeakableText

Parameters:

str - Text to be appended.

Returns:

This object.

isSpeakableTextEmpty

public boolean isSpeakableTextEmpty()

Checks if this speakable contains any text to be passed to the TTS engine.

Specified by:

isSpeakableTextEmpty in interface SpeakableText

Returns:

true if this speakable contains text.

isBargeInEnabled

public boolean isBargeInEnabled(org.jvoicexml.xml.vxml.BargeInType type)

Checks is barge-in is enabled for this speakable and the given bargein type.

Specified by:

isBargeInEnabled in interface SpeakableText

Parameters:

type - the bargein type to look for

Returns:

true if barge-in is enabled.

getBargeInType

public org.jvoicexml.xml.vxml.BargeInType getBargeInType()

Retrieves the barge-in type.

Returns:

the barge-in type

Since:

0.7.1

getTimeout

public long getTimeout()

Retrieves the timeout of this speakable to wait before a noinput event is generated.

Returns:

number of milliseconds to wait, -1 if there is no timeout specified.

Since:

0.6

setTimeout

public void setTimeout(long msec)

Sets the timeout that will be used for the following user input.

Parameters:

msec - number of milliseconds to wait.

Since:

0.6

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

0.6