org.jvoicexml.implementation

Interface OutputDevice

All Known Subinterfaces:

SynthesizedOutput

public interface OutputDevice

An output device for synthesized or audio file output.

Since:

0.6

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 of the given type.
boolean	isBusy() Checks if this device is busy with output.
boolean	supportsBargeIn() Checks if this implementation platform supports barge-in.

Method Detail

isBusy

boolean isBusy()

Checks if this device is busy with output.

Returns:

true if the device is busy.

supportsBargeIn

boolean supportsBargeIn()

Checks if this implementation platform supports barge-in.

Returns:

true if barge-in is supported.

Since:

0.7.1

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 of the given type. Does nothing if the current output can not be interrupted using barge-in.

This method is only called if supportsBargeIn() returns true.

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

Parameters:

type - the barge in type to cancel

Throws:

NoresourceError - The output resource is not available.

Since:

0.5