javax.telephony.media.provider
Class Base_SignalDetectorEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.telephony.media.provider.EventObject
              |
              +--javax.telephony.media.provider.Base.Event
                    |
                    +--javax.telephony.media.provider.Base.MediaServiceEvent
                          |
                          +--javax.telephony.media.provider.Base.ResourceEvent
                                |
                                +--javax.telephony.media.provider.Base_SignalDetectorEvent

All Implemented Interfaces:

Async_SignalDetectorEvent, Async.Event, Async.MediaServiceEvent, Async.ResourceEvent, Dispatcher.DispatchableEvent, MediaConstants, MediaEvent, MediaServiceConstants, MediaServiceEvent, ResourceConstants, ResourceEvent, java.io.Serializable, SignalConstants, SignalDetectorConstants, SignalDetectorEvent

Direct Known Subclasses:

S200_SignalDetectorEvent

public abstract class Base_SignalDetectorEvent

extends Base.ResourceEvent

implements Async_SignalDetectorEvent

Base_SignalDetectorEvent defines the methods used by SignalDetectorEvent/AsyncSignalDetectorEvent.

a bit hokey, since four event classes share the same class-type: ev_RetrieveSignals, ev_FlushBuffer, ev_Pattern[i], ev_SignalDetected.

The Symbols are inherited from SignalDetectorConstants via SignalDetectorEvent via Async_SignalDetectorEvent.

Since:

JTAPI-1.4

See Also:

Serialized Form

Inner classes inherited from class javax.telephony.media.provider.Base.Event

Base.Event.SyncInterruptedException

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

Fields inherited from interface javax.telephony.media.SignalDetectorConstants

a_Buffering, a_BufferSize, a_DiscardOldest, a_PatternCount, ev_FlushBuffer, ev_Overflow, ev_Pattern, ev_RetrieveSignals, ev_SignalDetected, p_Buffering, p_BufferSize, p_DiscardOldest, p_Duration, p_EnabledEvents, p_Filter, p_InitialTimeout, p_InterSigTimeout, p_Mode, p_Pattern, p_PatternCount, q_Duration, q_InitialTimeout, q_InterSigTimeout, q_NumSignals, q_Pattern, rtca_FlushBuffer, rtca_Stop, rtcc_FlushBuffer, rtcc_Pattern, rtcc_RetrieveSignals, rtcc_SignalDetected, v_Class, v_Detecting, v_Idle

Fields inherited from interface javax.telephony.media.SignalConstants

p_SymbolChar, v_CED, v_CNG, v_DTMF0, v_DTMF1, v_DTMF2, v_DTMF3, v_DTMF4, v_DTMF5, v_DTMF6, v_DTMF7, v_DTMF8, v_DTMF9, v_DTMFA, v_DTMFB, v_DTMFC, v_DTMFD, v_DTMFHash, v_DTMFStar, v_Unknown

Constructor Summary

Base_SignalDetectorEvent(java.lang.Object source, Symbol eventID)
Create specific completion or non-tranaction event from Recorder.

Method Summary

void	dispatch(java.util.EventListener listener) dispatch this event to Async_SignalDetectorListener
int	getPatternIndex() for eventID = ev_Pattern[i], get index "i"
abstract Symbol[]	getSignalBuffer() Get array of signal names.
abstract java.lang.String	getSignalString() Return SignalBuffer as a String.

Methods inherited from class javax.telephony.media.provider.Base.ResourceEvent

getRTCTrigger, throwIfMediaResourceException

Methods inherited from class javax.telephony.media.provider.Base.MediaServiceEvent

getMediaService

Methods inherited from class javax.telephony.media.provider.Base.Event

done, getError, getEventID, getException, getPayload, getQualifier, getSubError, getWarning, isDone, setError, setFields, setFields, setPayload, setQualifier, setSubError, throwIfRuntimeException, toString, waitForEventDone, waitForEventDone, waitForListenersDone

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.telephony.media.async.Async.ResourceEvent

throwIfMediaResourceException

Methods inherited from interface javax.telephony.media.async.Async.Event

isDone, throwIfRuntimeException, waitForEventDone, waitForEventDone, waitForListenersDone

Methods inherited from interface javax.telephony.media.MediaEvent

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

Methods inherited from interface javax.telephony.media.MediaServiceEvent

getMediaService

Methods inherited from interface javax.telephony.media.ResourceEvent

getRTCTrigger

Methods inherited from interface javax.telephony.media.SignalDetectorEvent

getSpacedString, getStringArray

Constructor Detail

Base_SignalDetectorEvent

public Base_SignalDetectorEvent(java.lang.Object source,
                                Symbol eventID)

Create specific completion or non-tranaction event from Recorder.

Parameters:

source - the Object that created this EventObject.

eventID - a Symbol that identifies this event: ev_RetrieveSignals, ev_FlushBuffer, ev_Pattern[i], ev_SignalDetected.

Method Detail

getPatternIndex

public int getPatternIndex()

for eventID = ev_Pattern[i], get index "i"

Specified by:

getPatternIndex in interface SignalDetectorEvent

Following copied from interface: javax.telephony.media.SignalDetectorEvent

Returns:

an int indicating which pattern was matched.

getSignalBuffer

public abstract Symbol[] getSignalBuffer()

Get array of signal names. Used for ev_retrieveSignals and ev_Pattern[i]. Each DTMF signal has a Symbol "name".

Specified by:

getSignalBuffer in interface SignalDetectorEvent

Following copied from interface: javax.telephony.media.SignalDetectorEvent

Returns:

a Symbol[], one Symbol for each Signal in the event.

getSignalString

public abstract java.lang.String getSignalString()

Return SignalBuffer as a String. Non-standard signals that have not been defined by setSignalChar() appear in the String as '?'.

Specified by:

getSignalString in interface SignalDetectorEvent

Returns:

a String representing SignalBuffer.

dispatch

public void dispatch(java.util.EventListener listener)

dispatch this event to Async_SignalDetectorListener

Overrides:

dispatch in class Base.Event

Following copied from class: javax.telephony.media.provider.Base.Event

Parameters:

listener - an EventListener, some kind of MediaListener.