org.jvoicexml.implementation.jvxml

Class DesktopTelephonySupport

java.lang.Object

org.jvoicexml.implementation.jvxml.DesktopTelephonySupport

All Implemented Interfaces:

ExternalResource, Telephony, RemoteConnectable

public final class DesktopTelephonySupport
extends java.lang.Object
implements Telephony

Implementation of a Telephony resource to be used in desktop/like environments.

This implementation of a Telephony resource can be used, if there is no telephony support or if the SpokenInput and SynthesizedOutput implementations are able to produced communicate directly with the user.

Since:

0.5.5

Constructor Summary

Constructors

Constructor and Description
DesktopTelephonySupport(javax.sound.sampled.AudioFormat format) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates this resource, when it is retrieved from the pool.
void	addListener(TelephonyListener callListener) Adds the given listener to the list of known listeners.
void	close() Closes and releases the acquired resources.
void	connect(ConnectionInformation client) Establishes a connection from the given ConnectionInformation to this object.
void	disconnect(ConnectionInformation client) Closes a previously established connection.
javax.sound.sampled.AudioFormat	getRecordingAudioFormat() Retrieves the audio format that should be used for file recording.
java.lang.String	getType() Retrieves a unique identifier for this external resource.
void	hangup() Hangs up the current call.
boolean	isActive() Checks if this instance can actively be used to play back output or record input.
boolean	isBusy() Checks if this device is busy.
void	open() Initializes and and acquires the needed resources.
void	passivate() Passivates this resource, when it is returned to the pool.
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 callListener) 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DesktopTelephonySupport

public DesktopTelephonySupport(javax.sound.sampled.AudioFormat format)

Constructs a new object.

Parameters:

format - the audio format to use for recording

Method Detail

activate

public void activate()

Activates this resource, when it is retrieved from the pool.

Specified by:

activate in interface ExternalResource

close

public void close()

Closes and releases the acquired resources.

Specified by:

close in interface ExternalResource

getType

public java.lang.String getType()

Retrieves a unique identifier for this external resource.

Specified by:

getType in interface ExternalResource

Returns:

unique identifier.

open

public void open()
          throws NoresourceError

Initializes and and acquires the needed resources.

Specified by:

open in interface ExternalResource

Throws:

NoresourceError - The resource could not be opened.

passivate

public void passivate()

Passivates this resource, when it is returned to the pool.

The external resource is requested to return all resources that were assigned while it was active.

Specified by:

passivate in interface ExternalResource

connect

public void connect(ConnectionInformation client)
             throws java.io.IOException

Establishes a connection from the given ConnectionInformation to this object.

Specified by:

connect in interface RemoteConnectable

Parameters:

client - data container with connection relevant data.

Throws:

java.io.IOException - error establishing the connection.

disconnect

public void disconnect(ConnectionInformation client)

Closes a previously established connection.

Specified by:

disconnect in interface RemoteConnectable

Parameters:

client - data container with connection relevant data.

play

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

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.

Specified by:

play in interface Telephony

Parameters:

output - the output device delivering the output.

props - parameters to use for playing.

Throws:

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

NoresourceError - Error accessing the terminal

stopPlay

public void stopPlay()
              throws NoresourceError

Stops a previously started play.

Specified by:

stopPlay in interface Telephony

Throws:

NoresourceError - Error accessing the terminal

record

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

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.

Specified by:

record in interface Telephony

Parameters:

input - input device to use for recording.

props - parameters to use for the recording.

Throws:

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

NoresourceError - Error accessing the terminal

getRecordingAudioFormat

public javax.sound.sampled.AudioFormat getRecordingAudioFormat()

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

Specified by:

getRecordingAudioFormat in interface Telephony

Returns:

audio format to use for recording.

startRecording

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

Starts recording to the given output stream.

Specified by:

startRecording in interface Telephony

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:

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

NoresourceError - Error accessing the terminal

stopRecording

public void stopRecording()
                   throws NoresourceError

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

Specified by:

stopRecording in interface Telephony

Throws:

NoresourceError - Error accessing the terminal

transfer

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

Transfers the current call.

Specified by:

transfer in interface Telephony

Parameters:

dest - Platform specific destination address

Throws:

NoresourceError - Error transferring the call.

hangup

public void hangup()

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

Specified by:

hangup in interface Telephony

addListener

public void addListener(TelephonyListener callListener)

Adds the given listener to the list of known listeners.

Specified by:

addListener in interface Telephony

Parameters:

callListener - TelephonyListener

removeListener

public void removeListener(TelephonyListener callListener)

Removes the given listener from the list of known listeners.

Specified by:

removeListener in interface Telephony

Parameters:

callListener - TelephonyListener

isBusy

public boolean isBusy()

Checks if this device is busy.

A device can be busy only if it is activated. Closed or passivated devices must return false.

Specified by:

isBusy in interface ExternalResource

Returns:

true if the device is busy.

isActive

public boolean isActive()

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

Specified by:

isActive in interface Telephony

Returns:

true if this instance is active