org.jvoicexml.implementation

Interface Telephony

All Superinterfaces:

ExternalResource, RemoteConnectable

All Known Implementing Classes:

DesktopTelephonySupport

public interface Telephony
extends ExternalResource

Telephony support as an external resource.

Objects that implement this interface are able to support making a third party connection through a communications network, such as the telephone.

In fact this is a bridge to use speech synthesis (via SynthesizedOutput and spoken input (via SpokenInput on a client, which may be a PBX. Hence, it is able to handle the communication between the client and the JVoiceXML server. The architecture is kept open at this point so that it is also possible to hook other clients, like the console or a PDA.

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

Method Summary

Modifier and Type	Method and Description
void	addListener(TelephonyListener listener) Adds the given listener to the list of known listeners.
javax.sound.sampled.AudioFormat	getRecordingAudioFormat() Retrieves the audio format that should be used for file recording.
void	hangup() Hangs up the current call.
boolean	isActive() Checks if this instance can actively be used to play back output or record input.
void	play(SynthesizedOutput output, CallControlProperties props) Plays a stream from the given output device.
void	record(SpokenInput input, CallControlProperties props) Starts recording to the given input device.
void	removeListener(TelephonyListener listener) Removes the given listener from the list of known listeners.
void	startRecording(SpokenInput input, java.io.OutputStream stream, CallControlProperties props) Starts recording to the given output stream.
void	stopPlay() Stops a previously started play.
void	stopRecording() Stops a previously started recording, e.g. after a recognition process has been stopped.
void	transfer(java.lang.String dest) Transfers the current call.

Methods inherited from interface org.jvoicexml.implementation.ExternalResource

activate, close, getType, isBusy, open, passivate

Methods inherited from interface org.jvoicexml.RemoteConnectable

connect, disconnect

Method Detail

play

void play(SynthesizedOutput output,
          CallControlProperties props)
   throws NoresourceError,
          java.io.IOException

Plays a stream from the given output device. This method gets called prior to calling SystemOutput.queueSpeakable(org.jvoicexml.SpeakableText, String, org.jvoicexml.DocumentServer) to prepare streaming from the synthesizer. Implementations may use this, method, e.g., to propagate OutputStreams to the SystemOutput implementation.

The play method is expected to run asynchronously.

Parameters:

output - the output device delivering the output.

props - parameters to use for playing.

Throws:

NoresourceError - Error accessing the terminal

java.io.IOException - Error accessing the given URI.

Since:

0.6

stopPlay

void stopPlay()
       throws NoresourceError

Stops a previously started play.

Throws:

NoresourceError - Error accessing the terminal

Since:

0.6

record

void record(SpokenInput input,
            CallControlProperties props)
     throws NoresourceError,
            java.io.IOException

Starts recording to the given input device. This method gets called prior to calling InputDevice.startRecognition(org.jvoicexml.interpreter.datamodel.DataModel, org.jvoicexml.SpeechRecognizerProperties, org.jvoicexml.DtmfRecognizerProperties) to prepare streaming to the recognizer. Implementations may use this, method, e.g., to propagate InputStreams to the SpokenInput implementation.

Parameters:

input - input device to use for recording.

props - parameters to use for the recording.

Throws:

NoresourceError - Error accessing the terminal

java.io.IOException - Error accessing the given URI.

Since:

0.6

getRecordingAudioFormat

javax.sound.sampled.AudioFormat getRecordingAudioFormat()

Retrieves the audio format that should be used for file recording.

Returns:

audio format to use for recording.

startRecording

void startRecording(SpokenInput input,
                    java.io.OutputStream stream,
                    CallControlProperties props)
             throws NoresourceError,
                    java.io.IOException

Starts recording to the given output stream.

Parameters:

input - input device that can be used in parallel to recognize the input.

stream - the stream where to send the recorded audio to.

props - parameters to use for the recording.

Throws:

NoresourceError - Error accessing the terminal

java.io.IOException - Error accessing the given URI.

Since:

0.6

stopRecording

void stopRecording()
            throws NoresourceError

Stops a previously started recording, e.g. after a recognition process has been stopped.

Throws:

NoresourceError - Error accessing the terminal

Since:

0.6

transfer

void transfer(java.lang.String dest)
       throws NoresourceError

Transfers the current call.

Parameters:

dest - Platform specific destination address

Throws:

NoresourceError - Error transferring the call.

isActive

boolean isActive()

Checks if this instance can actively be used to play back output or record input.

Returns:

true if this instance is active

Since:

0.7.7

hangup

void hangup()

Hangs up the current call. Error hanging up the call.

addListener

void addListener(TelephonyListener listener)

Adds the given listener to the list of known listeners.

Parameters:

listener - TelephonyListener

removeListener

void removeListener(TelephonyListener listener)

Removes the given listener from the list of known listeners.

Parameters:

listener - TelephonyListener