javax.telephony.media
Interface SignalDetectorEvent

All Superinterfaces:

MediaConstants, MediaEvent, MediaServiceConstants, MediaServiceEvent, ResourceConstants, ResourceEvent, SignalConstants, SignalDetectorConstants

All Known Subinterfaces:

Async_SignalDetectorEvent

public interface SignalDetectorEvent

extends ResourceEvent, SignalDetectorConstants

Defines the methods for SignalDetector Events.

Note: For JTAPI 1.3, we extend SignalDetectorEvent to work more easily with signals with multi-character names.

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

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

Method Summary

int	getPatternIndex() When eventID is one of ev_Pattern[i], return the int i.
Symbol[]	getSignalBuffer() Get signals as an array of Symbols.
java.lang.String	getSignalString() Get signals as a single String.
java.lang.String	getSpacedString() Get signals as a single String with a space character between each signal.
java.lang.String[]	getStringArray() Get signals as an array of Strings.

Methods inherited from interface javax.telephony.media.ResourceEvent

getRTCTrigger

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

getSignalString

public java.lang.String getSignalString()

Get signals as a single String. The return value is constructed by concatenating the single-character String equivalents for each signal Symbol.

Each DTMF signal has a single character equivalent, one of: 0,1,2,3,4,5,6,7,8,9,*,#,A,B,C,D. The fax tones "CNG" and "CED" are represtented by the characters '>' and '<' respectively.

If the SignalBuffer contains non-DTMF signals that do not have defined char equivalents, then a '?' is inserted in that place.

Note: For all the standard (or unknown) signals and signal names, getSignalString.charAt(n) corresponds to the Nth signal retrieved. However, if a signal is retrieved that has been assigned a multi-character name (using p_SymbolChar) then this correspondence does not hold. For signals with multi-character names, consider using getSpacedString() or getSignalBuffer().

Note: When getEventID() = ev_flushBuffer and getQualifier() = q_RTC, some implementations may not return the flushed signals. In that case, this method returns null.

Returns:

a String of DTMF signal characters.

getSpacedString

public java.lang.String getSpacedString()

Get signals as a single String with a space character between each signal. Signals with multi-character names appear with their full name.

For example, two Fax CALLING tones would appear as: "CNG CNG"

Note: Returns null if there are no signals in the event.

Returns:

a String of DTMF Signal chars.

getStringArray

public java.lang.String[] getStringArray()

Get signals as an array of Strings. Each signal appears as its associated String name. Signals with multi-character names appear with their full name.

This method is useful for examining Signals that are not represented by single character names. In particular, extensions to the SignalDetector may use Strings to define new signals.

Note: This method is for compatibility with ECTF S.100 SignalDetectors that may recognize signals for which there is no defined Symbol.

Note: When getEventID() == ev_flushBuffer and getQualifier() == q_RTC, some implementations may not return the flushed signals. In that case, this method returns null.

Returns:

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

See Also:

getSpacedString()

getSignalBuffer

public Symbol[] getSignalBuffer()

Get signals as an array of Symbols. Each signal appears as its associated Symbol.

This method is useful for examining Signals that are not represented by single character names. In particular, extensions to the SignalDetector may use the Symbol namespace to define new signals.

Note: When getEventID() = ev_flushBuffer and getQualifier() = q_RTC, some implementations may not return the flushed signals. In that case, this method returns null.

Returns:

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

getPatternIndex

public int getPatternIndex()

When eventID is one of ev_Pattern[i], return the int i. If eventID is not ev_Pattern[i], then return minus one (-1).

Returns:

an int indicating which pattern was matched.