org.jvoicexml

Interface ImplementationPlatform

All Superinterfaces:

PromptAccumulator

All Known Implementing Classes:

JVoiceXmlImplementationPlatform

public interface ImplementationPlatform
extends PromptAccumulator

The implementation platform is controlled by the VoiceXML interpreter context and by the VoiceXML interpreter.

The implementation platform generates events in response to user actions (e.g. spoken or character input received, disconnect) and system events (e.g. timer expiration). Some of these events are acted upon the VoiceXML interpreter itself, as specified by the VoiceXML document, while others are acted upon by the VoiceXML interpreter context.

This is a facade to access the resources that are capable to handle those user actions.

Since:

0.5.5

Method Summary

Modifier and Type	Method and Description
void	close() Closes all open resources.
CallControl	getCallControl() Retrieves the calling device.
DtmfInput	getCharacterInput() Retrieves the DTMF input device.
SystemOutput	getSystemOutput() Retrieves the audio output device.
UserInput	getUserInput() Retrieves the user input device.
boolean	isUserInputActive() Checks, if there is an acquired user input device.
void	setEventBus(EventBus bus) Sets the event bus to communicate events back to the interpreter.
void	setSession(Session session) Sets the current session.
void	waitNonBargeInPlayed() Delays until all prompts are played that do not allow for barge-in.
void	waitOutputQueueEmpty() Delays until all prompts are played.

Methods inherited from interface org.jvoicexml.PromptAccumulator

queuePrompt, renderPrompts, setPromptTimeout

Method Detail

getSystemOutput

SystemOutput getSystemOutput()
                      throws NoresourceError,
                             ConnectionDisconnectHangupEvent

Retrieves the audio output device.

Returns:

Audio output device to use, never null.

Throws:

NoresourceError - Output device is not available.

ConnectionDisconnectHangupEvent - the user hung up

waitOutputQueueEmpty

void waitOutputQueueEmpty()

Delays until all prompts are played. This is needed e.g. for recording to ensure that we do not record and play prompts in parallel.

waitNonBargeInPlayed

void waitNonBargeInPlayed()

Delays until all prompts are played that do not allow for barge-in.

Since:

0.7

isUserInputActive

boolean isUserInputActive()

Checks, if there is an acquired user input device.

Returns:

true if there is an acquired user input device.

Since:

0.7.3

getUserInput

UserInput getUserInput()
                throws NoresourceError,
                       ConnectionDisconnectHangupEvent

Retrieves the user input device.

Returns:

User input device to use, never null.

Throws:

NoresourceError - Input device is not available.

ConnectionDisconnectHangupEvent - the user hung up

getCharacterInput

DtmfInput getCharacterInput()
                     throws NoresourceError,
                            ConnectionDisconnectHangupEvent

Retrieves the DTMF input device.

Returns:

DTMF input device to use.

Throws:

NoresourceError - Input device is not available.

ConnectionDisconnectHangupEvent - the user hung up

getCallControl

CallControl getCallControl()
                    throws NoresourceError,
                           ConnectionDisconnectHangupEvent

Retrieves the calling device.

Returns:

Calling device to use, never null.

Throws:

NoresourceError - Calling device is not available.

ConnectionDisconnectHangupEvent - the user hung up

close

void close()

Closes all open resources.

setEventBus

void setEventBus(EventBus bus)

Sets the event bus to communicate events back to the interpreter.

Parameters:

bus - the event bus

Since:

0.7.7

setSession

void setSession(Session session)

Sets the current session.

Parameters:

session - the current session.