org.jvoicexml.implementation.jsapi10
Interface SynthesizedOutputConnectionHandler

All Known Implementing Classes:

FreeTTSConnectionHandler

public interface SynthesizedOutputConnectionHandler

JSAPI 1.0 does not know how to stream audio from a server to a client. However, custom implementations exist to fill this gap. Classes implementing this interface can be used to address this custom implementation.

Note that there is only one object to handle the connections for all synthesizers.

Since:

0.6

Version:

$Revision: 2355 $

Author:

Dirk Schnelle

Field Summary

static String

CONFIG_KEY Configuration key.

Method Summary

void	connect(ConnectionInformation client, SynthesizedOutput output, Synthesizer synthesizer) Establishes a connection from the given ConnectionInformation to this object.
void	disconnect(ConnectionInformation client, SynthesizedOutput output, Synthesizer synthesizer) Disconnects a previously established connection.
URI	getUriForNextSynthesisizedOutput(ConnectionInformation client) Delegate from SynthesizedOutput.getUriForNextSynthesisizedOutput() .

Field Detail

CONFIG_KEY

static final String CONFIG_KEY

Configuration key.

See Also:

Constant Field Values

Method Detail

connect

void connect(ConnectionInformation client,
             SynthesizedOutput output,
             Synthesizer synthesizer)
             throws IOException

Establishes a connection from the given ConnectionInformation to this object.

Parameters:

client - data container with connection relevant data.

output - the current synthesized output.

synthesizer - the current synthesizer.

Throws:

IOException - error establishing the connection.

disconnect

void disconnect(ConnectionInformation client,
                SynthesizedOutput output,
                Synthesizer synthesizer)

Disconnects a previously established connection.

Parameters:

client - data container with connection relevant data.

output - the current synthesized output.

synthesizer - the current synthesizer.

getUriForNextSynthesisizedOutput

URI getUriForNextSynthesisizedOutput(ConnectionInformation client)
                                     throws NoresourceError

Delegate from SynthesizedOutput.getUriForNextSynthesisizedOutput() .

Parameters:

client - data container with connection relevant data.

Returns:

URI of the input source, maybe null if the streaming uses other means of audio output.

Throws:

NoresourceError - Error accessing the device.