org.jvoicexml

Interface CallControl

public interface CallControl

Call control.

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

Method Summary

Modifier and Type	Method and Description
javax.sound.sampled.AudioFormat	getRecordingAudioFormat() Retrieves the audio format that should be used for file recording.
void	hangup() Generate an application driven hangup.
boolean	isCallActive() Checks if the call is currently active and outputs can be sent and inputs can be retrieved.
void	play(SystemOutput output, CallControlProperties props) Plays a stream from the given output device.
void	record(UserInput input, CallControlProperties props) Starts recording to the given input device.
void	startRecording(UserInput input, java.io.OutputStream stream, CallControlProperties props) Starts recording to the given output stream.
void	stopPlay() Stops a previously started play.
void	stopRecord() Stops a previously started recording.
void	transfer(java.lang.String dest) Transfers the current call.

Method Detail

play

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

Plays a stream from the given output device.

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

record

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

Starts recording to the given input device.

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(UserInput input,
                    java.io.OutputStream stream,
                    CallControlProperties props)
             throws NoresourceError,
                    java.io.IOException

Starts recording to the given output stream.

Parameters:

input - input device to use for recording. This can be used e.g. to recognize the recorded data.

stream - the stream where to store the 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

stopRecord

void stopRecord()
         throws NoresourceError

Stops a previously started recording.

Throws:

NoresourceError - Error accessing the terminal

Since:

0.6

stopPlay

void stopPlay()
       throws NoresourceError

Stops a previously started play.

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.

isCallActive

boolean isCallActive()

Checks if the call is currently active and outputs can be sent and inputs can be retrieved. This is usally true after a call has started and hangup() has not been called.

Returns:

true if the call is active

Since:

0.7.7

hangup

void hangup()

Generate an application driven hangup.

Since:

0.7.5