javax.telephony.media
Interface ResourceEvent

All Superinterfaces:

MediaConstants, MediaEvent, MediaServiceConstants, MediaServiceEvent, ResourceConstants

All Known Subinterfaces:

ASREvent, Async_ASREvent, Async_PlayerEvent, Async_RecorderEvent, Async_SignalDetectorEvent, Async_SignalGeneratorEvent, Async.ResourceEvent, PlayerEvent, RecorderEvent, SignalDetectorEvent, SignalGeneratorEvent

public interface ResourceEvent

extends MediaServiceEvent, ResourceConstants

The simple, synchronous interface to Resource Events. ResourceEvent objects are returned from Resource methods and non-tranactional ResourceEvents are delivered to a ResourceListener.

When a media resource method (for a Player, Recorder, etc.) completes successfully, it returns a ResourceEvent to the invoking program. If the method does not complete normally (ie, if the post-conditions are not satisfied), then the method throws a MediaResourceException that contains a ResourceEvent (accessible using getResourceEvent()). In either case, the ResourceEvent can be queried for additional information.

ResourceEvent properties:

Each ResourceEvent has the MediaEvent properties (EventID, Qualifier or Error and SubError), plus an RTCTrigger. ResourceEvent defines get method for RTCTrigger.

If a media resource generates events that have additional fields, then the Event interface for that resource extends ResourceEvent by defining methods to access the additional information.

Names for Symbol constants used in ResourceEvent objects:

The constants (Symbols and ints) defined in ResourceConstants are inherited by ResourceEvent. Other Resource interfaces may define additional constants.

The Symbols returned by	have names of the form:
getEventID()	ev_OperationName
getQualifier()	q_ReasonName
getRTCTrigger()	rtcc_ConditionName
getError()	e_ErrorName

Since:

JTAPI-1.3

Fields inherited from interface javax.telephony.media.MediaServiceConstants

ev_BindAndConnect, ev_BindToCall, ev_BindToServiceName, ev_BindToTerminal, ev_BindToTerminalName, ev_Configure, ev_Connected, ev_DelegateToService, ev_Disconnected, ev_GetConfigSpec, ev_GetConfiguration, ev_GetParameters, ev_GetTerminal, ev_GetTerminalName, ev_GetUserValues, ev_GroupStop, ev_Release, ev_ReleaseDelegated, ev_ReleaseToDestroy, ev_ReleaseToService, ev_ReleaseToTag, ev_Retrieve, ev_Retrieved, ev_SetParameters, ev_SetUserDictionary, ev_SetUserValues, ev_TerminalIdle, ev_TriggerRTC

Fields inherited from interface javax.telephony.media.MediaConstants

e_OK, q_Duration, q_Standard, q_Stop

Fields inherited from interface javax.telephony.media.ResourceConstants

e_Disconnected, FOREVER, q_Disconnected, q_RTC, rtcc_Disconnected, rtcc_TriggerRTC, v_Forever

Method Summary

Symbol

getRTCTrigger() Get the RTC Trigger that caused this transaction completion.

Methods inherited from interface javax.telephony.media.MediaServiceEvent

getMediaService

Methods inherited from interface javax.telephony.media.MediaEvent

getError, getEventID, getException, getPayload, getQualifier, getSubError, getWarning

Method Detail

getRTCTrigger

public Symbol getRTCTrigger()

Get the RTC Trigger that caused this transaction completion. This is non-null iff getQualifier == ResourceEvent.q_RTC

The Symbol returned has a name of the form rtcc_Something.

Returns:

a Symbol identifying an RTC trigger condition.