hp.telephony.media
Interface SignalDetectorEvent

All Superinterfaces:

MediaEvent, ResourceConstants, ResourceEvent, SignalConstants, SignalDetectorConstants

public interface SignalDetectorEvent

extends ResourceEvent, SignalDetectorConstants

SignalDetectorEvent defines the methods for SignalDetector Events.

Since:

OCMP 2.0

Field Summary

Fields inherited from interface hp.telephony.media.MediaEvent

ev_Disconnected, ev_TerminalIdle

Fields inherited from interface hp.telephony.media.ResourceConstants

e_Disconnected, e_OK, FOREVER, q_Duration, q_RTC, q_Standard, q_Stop, rtcc_Disconnected, rtcc_TriggerRTC, v_Forever

Fields inherited from interface hp.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_DtmfDetectorMode, 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_DetectFaxCallingTone, rtca_EvalBuffer, rtca_FlushBuffer, rtca_IgnoreFaxCallingTone, rtca_PassSignalsThru, rtca_Stop, rtca_TruncateSignals, rtcc_FlushBuffer, rtcc_Pattern, rtcc_RetrieveSignals, rtcc_SignalDetected, v_Detecting, v_Idle

Fields inherited from interface hp.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_DtmfInBand, v_DtmfInBandOutBand, v_DtmfNone, v_DtmfOutBand, v_DTMFStar

Method Summary

int	getPatternIndex() When eventID is one of ev_Pattern[i], return the int i.
Symbol[]	getSignalBuffer() Get array of signal names.
String	getSignalString() Get SignalBuffer as a String.

Methods inherited from interface hp.telephony.media.ResourceEvent

getError, getQualifier, getRTCTrigger

Methods inherited from interface hp.telephony.media.MediaEvent

getEventID

Method Detail

getSignalString

public String getSignalString()

Get SignalBuffer as a String. Each DTMF signal has a single char equivalent, one of: 0,1,2,3,4,5,6,7,8,9,*,#,A,B,C,D. If the Signal Buffer contains non-DTMF signals that do not have defined char equivalents, then a '?' is inserted in that place.

Note: Some implementations may not return the flushed signal(s). In that case, this method returns null.

Returns:

a String of DTMF Signal chars.

getSignalBuffer

public Symbol[] getSignalBuffer()

Get array of signal names. Each signal has a Symbol "name".

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: Some implementations may not return the flushed signal(s). In that case, this method returns null.

Returns:

an Array of Symbols, one 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.