hp.telephony.media
Interface MediaEvent

All Known Subinterfaces:

ASRRecorderEvent, FaxEvent, PlayerEvent, RecorderEvent, ResourceEvent, SignalDetectorEvent, SignalGeneratorEvent, SMSPlayerEvent, SMSRecorderEvent, TTSPlayerEvent

public interface MediaEvent

An event from a MediaService. Characterized by the MediaService which is the source of the event, and an EventID representing the event identity.

Note: Classes that implement this interface shall follow the standard Java Listener design pattern by extending java.util.EventObject.

Since:

OCMP 2.0

Field Summary

static Symbol	ev_Disconnected Indicates that a Connection to this MediaService has been disconnected.
static Symbol	ev_TerminalIdle Indicates that all Connections to this MediaService have been disconnected.

Method Summary

Symbol

getEventID() Get the Symbol that identifies this event.

Field Detail

ev_Disconnected

public static final Symbol ev_Disconnected

Indicates that a Connection to this MediaService has been disconnected. A MediaEvent with this EventID is sent to Service Listener onDisconnected if the Connection to this MediaService transitions to the state If ConfigSpecConstants.a_StopOnDisconnect = TRUE then all current resource transactions are terminated with qualifier q_Disconnected.

ev_TerminalIdle

public static final Symbol ev_TerminalIdle

Indicates that all Connections to this MediaService have been disconnected. A MediaEvent with this EventID is sent to the Service Listener onDisconnected when the last Connection to this MediaService transitions to the state disconnected All current resource transactions are terminated with qualifier q_Disconnected.

Method Detail

getEventID

public Symbol getEventID()

Get the Symbol that identifies this event.

For completion events, this identifies the operation that has completed. For synchronous code this is mostly redundant, but it may be useful for asynchronous Listeners. Further detail about how/why the operation completed is available using ResourceEvent.getQualifier().

The Symbols returned from by this method will have names of the form: ev_Operation.

Returns:

the Symbol that identifies this event

See Also:

ResourceEvent