[Package Index] [Index] [Users' Guide] [SVAPI Home Page]

Interface COM.novell.SVAPI.Engine

public interface Engine extends Remote

The Engine interface is the base interface off of which all engine types inherit.



Method Index

createUtterance(byte[])
Creates an utterance from binary data.
createUtterance(URL)
Creates an utterance from a URL.
deinitialize()
Deinitializes the engine, unloading all resources consumed by the connection.
disconnectAudio()
Disconnects the engine from the audio device or stream.
getChannel()
Returns the audio stream's channel identifier.
getParameters()
Gets the engine's Parameters object.
getProperties()
Returns the engine's description object.
initialize()
Initializes the engine, loading the necessary resources to perform the engine's function.
isAudioConnected()
Returns true if the engine is connected to an audio device or stream.
isEngineCompatible(Engine)
Determines if objects obtained from this engine are interchangable with objects obtained from the specified engine.
setChannel(String)
Sets the audio stream's channel identifier.
useDesktopAudio()
Causes the engine to connect to the desktop audio device.
useDeviceAudio(int)
Causes the engine to connect to a local audio audio device.
useTelephoneAudio(Terminal)
Causes the engine to connect to the audio of a Java telephony call.



Methods



getParameters

public abstract Parameters getParameters()
Gets the engine's Parameters object. The engine's optional.parameters.engine property can be queried to determine what parameters are supported. If the engine does not support any parameters, this function returns null.
Exceptions:


getProperties

public abstract EngineProperties getProperties()
Returns the engine's description object.
Exceptions:


initialize

public abstract void initialize()
Initializes the engine, loading the necessary resources to perform the engine's function. Establishing a connection to an engine is a two step process. First, an instance of the engine must be obtained from the SVAPI class. Second, the engine's initialize method must be called. Two-step initialization allows calls to be made before the actual engine initialization takes place.
Exceptions:
See Also: deinitialize


deinitialize

public abstract void deinitialize()
Deinitializes the engine, unloading all resources consumed by the connection. The application should not make any further calls to the engine. Doing so will result in undefined behavior. All engines should override the finalize method and call its deinitialize method.
Exceptions:
See Also: initialize


useDesktopAudio

public abstract void useDesktopAudio()
Causes the engine to connect to the desktop audio device.
Exceptions:
See Also: disconnectAudio, isAudioConnected


useDeviceAudio

public abstract void useDeviceAudio(int Device)
Causes the engine to connect to a local audio audio device. The device identifier is operating system and platform dependent.
Exceptions:
See Also: disconnectAudio, isAudioConnected


useTelephoneAudio

public abstract void useTelephoneAudio(Terminal Terminal)
Causes the engine to connect to the audio of a Java telephony call.
Exceptions:
See Also: disconnectAudio, isAudioConnected


disconnectAudio

public abstract void disconnectAudio()
Disconnects the engine from the audio device or stream.
Exceptions:
See Also: isAudioConnected


isAudioConnected

public abstract boolean isAudioConnected()
Returns true if the engine is connected to an audio device or stream.
Exceptions:
See Also: disconnectAudio


getChannel

public abstract String getChannel()
Returns the audio stream's channel identifier. The channel identifiers that the engine supports can be determined by querying the engine's audio.channels property.
Exceptions:
See Also: setChannel, Model.getChannel


setChannel

public abstract void setChannel(String Channel)
Sets the audio stream's channel identifier. The channel identifiers that the engine supports can be determined by querying the engine's audio.channels property.
Exceptions:
See Also: getChannel, Model.setChannel


createUtterance

public abstract Utterance createUtterance(URL URL)
Creates an utterance from a URL.
Exceptions:


createUtterance

public abstract Utterance createUtterance(byte Data[])
Creates an utterance from binary data.
Exceptions:


isEngineCompatible

public abstract boolean isEngineCompatible(Engine Engine)
Determines if objects obtained from this engine are interchangable with objects obtained from the specified engine. If this function returns true, utterances and models from one of the engines can be used in the other. This is useful for efficient use of multiple technologies that operate on the same utterances and/or models. For example, utterances obtained from a classification engine can be passed directly to an identification engine if this function returns true for the two engines.
Exceptions:



[Package Index] [Index] [Users' Guide] [SVAPI Home Page]

rwille@novell.com