Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech
interface EngineEvent
Files: GNOME_Speech.idl
GNOME-Speech-EngineEvent-inheritance GNOME-Speech-EngineErrorEvent.html GNOME-Speech-Recognition-RecognizerEvent.html GNOME-Speech-Synthesis-SynthesizerEvent.html GNOME-Speech-SpeechEvent.html GNOME-Speech-SpeechObject.html Bonobo-Unknown.html

EngineEvent notifies changes in state of a speech synthesis or recognition engine. EngineEvents are issued to each EngineListener attached to an engine. The RecognizerEvent and SynthesizerEvent classes both extend #EngineEvent to provide specific events for recognizers and synthesizers.

See Also:
EngineListener
RecognizerEvent
SynthesizerEvent


Consts Summary:
longENGINE_ALLOCATED = 501
longENGINE_DEALLOCATED = 502
longENGINE_ALLOCATING_RESOURCES = 503
longENGINE_DEALLOCATING_RESOURCES = 504
longENGINE_PAUSED = 505
longENGINE_RESUMED = 506

Operations Summary:
 voidinitWithEngineAndState(in Engine source, in long id, in long long oldEngineState, in long long newEngineState)
 longgetNewEngineState()
 longgetOldEngineState()

Operations Inherited from SpeechEvent
init, initWithId, getId, getSource, paramString, toString

Operations Inherited from Bonobo::Unknown
ref, unref, queryInterface

Const Details:
long ENGINE_ALLOCATED = 501

Identifier for event issued when engine allocation is complete. The ALLOCATED flag of the newEngineState is set.

See Also:
getNewEngineState
SpeechEvent#getId
Engine#allocate
EngineListener#engineAllocated


long ENGINE_DEALLOCATED = 502

Identifier for event issued when engine deallocation is complete. The DEALLOCATED flag of the newEngineState is set.

See Also:
getNewEngineState
SpeechEvent#getId
Engine#allocate
EngineListener#engineDeallocated


long ENGINE_ALLOCATING_RESOURCES = 503

Identifier for event issued when engine allocation has commenced. The ALLOCATING_RESOURCES flag of the newEngineState is set.

See Also:
getNewEngineState
SpeechEvent#getId
Engine#allocate
EngineListener#engineAllocatingResources


long ENGINE_DEALLOCATING_RESOURCES = 504

Identifier for event issued when engine deallocation has commenced. The DEALLOCATING_RESOURCES flag of the newEngineState is set.

See Also:
getNewEngineState
SpeechEvent#getId
Engine#allocate
EngineListener#engineDeallocatingResources


long ENGINE_PAUSED = 505

Identifier for event issued when engine is paused. The PAUSED flag of the newEngineState is set.

See Also:
getNewEngineState
SpeechEvent#getId
Engine#pause
EngineListener#enginePaused


long ENGINE_RESUMED = 506

Identifier for event issued when engine is resumed. The RESUMED flag of the newEngineState is set.

See Also:
getNewEngineState
SpeechEvent#getId
Engine#resume
EngineListener#engineResumed


Operation Details:
 void initWithEngineAndState(in Engine source, in long id, in long long oldEngineState, in long long newEngineState)

Constructs an EngineEvent with an event identifier, old engine state and new engine state.

Parameters:
source - the object that issued the event.
id - the identifier for the event type.
oldEngineState - engine state prior to this event.
newEngineState - engine state following this event.
See Also:
Engine#getEngineState


 long getNewEngineState()

Return the state following this EngineEvent. The value matches the getEngineState method.

Return:
the state following this EngineEvent.
See Also:
Engine#getEngineState


 long getOldEngineState()

Return the state prior to this EngineEvent. The value matches the getEngineState method.

Return:
the state prior to this EngineEvent.
See Also:
Engine#getEngineState