org.jvoicexml
Interface ImplementationPlatform

All Known Implementing Classes:

JVoiceXmlImplementationPlatform

public interface ImplementationPlatform

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.

Since:

0.5.5

Copyright © 2006 JVoiceXML group - http://jvoicexml.sourceforge.net/

Version:

$Revision: 168 $

Author:

Dirk Schnelle

See Also:

VoiceXmlInterpreter

Method Summary

void	close() Closes all open resources.
CallControl	getCallControl() Retrieves the calling device.
CharacterInput	getCharacterInput() Retrieves the DTMF input device.
SystemOutput	getSystemOutput() Retrieves the audio output device.
UserInput	getUserInput() Retrieves the user input device.
void	setEventHandler(EventObserver observer) Sets the event observer to communicate events back to the interpreter.

Method Detail

getSystemOutput

SystemOutput getSystemOutput()
                             throws NoresourceError

Retrieves the audio output device.

Returns:

Audio output device to use.

Throws:

NoresourceError - Output device is not available.

getUserInput

UserInput getUserInput()
                       throws NoresourceError

Retrieves the user input device.

Returns:

User input device to use.

Throws:

NoresourceError - Input device is not available.

getCharacterInput

CharacterInput getCharacterInput()
                                 throws NoresourceError

Retrieves the DTMF input device.

Returns:

DTMF input device to use.

Throws:

NoresourceError - Input device is not available.

getCallControl

CallControl getCallControl()
                           throws NoresourceError

Retrieves the calling device.

Returns:

Calling device to use.

Throws:

NoresourceError - Calling device is not available.

close

void close()

Closes all open resources.

setEventHandler

void setEventHandler(EventObserver observer)

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

Parameters:

observer - The event observer.

Since:

0.5