org.jvoicexml

Interface SystemOutput

public interface SystemOutput

Facade for easy access to the system output.

Objects that implement this interface support audio output using audio files and text-to-speech (TTS). They are able to freely sequence TTS and audio output.

If an audio output resource is not available, an error.noresource event is thrown. Audio files are referred to by a URI. The language specifies a required set of audio file formats which must be supported; additional audio file formats may also be supported.

Method Summary

Modifier and Type	Method and Description
void	cancelOutput(org.jvoicexml.xml.vxml.BargeInType type) Cancels the current output from the TTS engine and queued audio for all entries in the queue that allow barge-in.
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.

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 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.

cancelOutput

void cancelOutput(org.jvoicexml.xml.vxml.BargeInType type)
           throws NoresourceError

Cancels the current output from the TTS engine and queued audio for all entries in the queue that allow barge-in.

The implementation has to maintain a list of cancelable outputs depending on the barge-in flag.

Parameters:

type - the bargein type to cancel

Throws:

NoresourceError - The output resource is not available.

Since:

0.5