org.jvoicexml.implementation

Interface SynthesizedOutput

All Superinterfaces:

ExternalResource, OutputDevice, RemoteConnectable

public interface SynthesizedOutput
extends ExternalResource, OutputDevice

Facade for easy access to the system output as an external resource.

Objects that implement this interface support audio output text-to-speech (TTS).

It is guaranteed that the session remains the same between the calls to RemoteConnectable.connect(org.jvoicexml.ConnectionInformation) and RemoteConnectable.disconnect(org.jvoicexml.ConnectionInformation).

Since:

0.6

Method Summary

Modifier and Type	Method and Description
void	addListener(SynthesizedOutputListener listener) Adds the listener for system output events.
void	queueSpeakable(SpeakableText speakable, java.lang.String sessionId, DocumentServer documentServer) The Speakable object is added to the end of the speaking queue and will be spoken once it reaches the top of the queue.
void	removeListener(SynthesizedOutputListener listener) Removes the listener for system output events.
void	waitNonBargeInPlayed() Delays until all prompts are played that do not allow for barge-in.
void	waitQueueEmpty() Convenient method to wait until all output is being played.

Methods inherited from interface org.jvoicexml.implementation.ExternalResource

activate, close, getType, isBusy, open, passivate

Methods inherited from interface org.jvoicexml.RemoteConnectable

connect, disconnect

Methods inherited from interface org.jvoicexml.implementation.OutputDevice

cancelOutput, isBusy, supportsBargeIn

Method Detail

queueSpeakable

void queueSpeakable(SpeakableText speakable,
                    java.lang.String sessionId,
                    DocumentServer documentServer)
             throws NoresourceError,
                    BadFetchError

The Speakable object is added to the end of the speaking queue and will be spoken once it reaches the top of the queue.

Parameters:

speakable - Text to be spoken.

sessionId - the current session id

documentServer - The document server to use.

Throws:

NoresourceError - The output resource is not available.

BadFetchError - A URI within the speakable could not be obtained or a parsing error occurred.

waitNonBargeInPlayed

void waitNonBargeInPlayed()

Delays until all prompts are played that do not allow for barge-in.

Since:

0.7.1

waitQueueEmpty

void waitQueueEmpty()

Convenient method to wait until all output is being played.

addListener

void addListener(SynthesizedOutputListener listener)

Adds the listener for system output events.

The implementation of this interface must notify the listener about all events.

Parameters:

listener - the listener to add.

removeListener

void removeListener(SynthesizedOutputListener listener)

Removes the listener for system output events.

Parameters:

listener - the listener to remove.

Since:

0.6