javax.telephony.media
Interface SignalDetectorConstants

All Superinterfaces:

MediaConstants, ResourceConstants, SignalConstants

All Known Subinterfaces:

Async_SignalDetector, Async_SignalDetectorEvent, SignalDetector, SignalDetectorEvent

public interface SignalDetectorConstants

extends ResourceConstants, SignalConstants

Defines the Symbols used by the SignalDetector Resource.

The Symbols that name DTMF, CNG and CED signals are inherited from SignalConstants.

Since:

JTAPI-1.3

Field Summary

static Symbol	a_Buffering Attribute to request support for buffering, required to support pattern matching.
static Symbol	a_BufferSize Requests capability for specific size of Signal Buffer.
static Symbol	a_DiscardOldest Requests capability to automatically discard oldest signals when buffer fills.
static Symbol	a_PatternCount Requests support for the Pattern detection features.
static Symbol	ev_FlushBuffer FlushBuffer completion event.
static Symbol	ev_Overflow The SignalDetector signal buffer has overflowed.
static Symbol[]	ev_Pattern Array of pattern Symbols, indicating a pattern matched event.
static Symbol	ev_RetrieveSignals Completion event for retrieveSignals.
static Symbol	ev_SignalDetected A single Signal has been detected.
static Symbol	p_Buffering Enable/disable buffering of signals.
static Symbol	p_BufferSize Size of the signal buffer.
static Symbol	p_DiscardOldest Boolean that indicates whether the oldest signals are discarded when the signal buffer overflows.
static Symbol	p_Duration Maximum time duration for retrieving signals in milliseconds.
static Symbol	p_EnabledEvents A Dictionary of SignalGenerator event Symbols, indicating which events are generated and delivered to the application.
static Symbol	p_Filter Enable/disable pattern filtering.
static Symbol	p_InitialTimeout Maximum time limit for first signal.
static Symbol	p_InterSigTimeout Maximum time limit between consecutive signals.
static Symbol	p_Mode Enable/disable the signal detector.
static Symbol[]	p_Pattern Each p_Pattern[i] defines a pattern to be matched.
static Symbol	p_PatternCount Number of pattern definitions supported by this SignalDetector resource.
static Symbol	q_Duration Complete because total duration timeout (p_Duration) exceeded.
static Symbol	q_InitialTimeout Complete because initial signal timeout (p_InitialTimeout) exceeded.
static Symbol	q_InterSigTimeout Complete because inter signal timeout (p_InterSigTimeout) exceeded.
static Symbol	q_NumSignals Complete because requested number of signals detected.
static Symbol[]	q_Pattern The array of Pattern Symbols which appear as qualifiers.
static Symbol	rtca_FlushBuffer RTC Action to cause the buffer to be flushed.
static Symbol	rtca_Stop RTC Action to cause the current operation to stop.
static Symbol	rtcc_FlushBuffer RTC trigger when buffer has been flushed.
static Symbol[]	rtcc_Pattern RTC trigger when the corresponding pattern event was issued.
static Symbol	rtcc_RetrieveSignals RTC trigger when completion event ev_RetrieveSignals was issued.
static Symbol	rtcc_SignalDetected RTC trigger when some signal has been detected.
static Symbol	v_Class Denotes the standard SignalDetector Resource Class in a ResourceSpec.
static Symbol	v_Detecting value for p_Mode.
static Symbol	v_Idle value for p_Mode.

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.MediaConstants

e_OK, q_Standard, q_Stop

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

Field Detail

v_Class

public static final Symbol v_Class

Denotes the standard SignalDetector Resource Class in a ResourceSpec.

a_Buffering

public static final Symbol a_Buffering

Attribute to request support for buffering, required to support pattern matching.

Value is a Boolean indicating if Buffering is required.
Default value: false

a_BufferSize

public static final Symbol a_BufferSize

Requests capability for specific size of Signal Buffer.

Value is the Integer number of signals to buffer.
Default value: is implementation dependent, but is at least 35.

a_DiscardOldest

public static final Symbol a_DiscardOldest

Requests capability to automatically discard oldest signals when buffer fills.

Default value: vendor specific.

a_PatternCount

public static final Symbol a_PatternCount

Requests support for the Pattern detection features. Used in ConfigSpec.

Value is the Integer number of patterns supported.
Default value: implementation dependant, but at least 32.

See Also:

p_Pattern, p_PatternCount

ev_FlushBuffer

public static final Symbol ev_FlushBuffer

FlushBuffer completion event. getSignalBuffer returns the signals that were discarded or null if that information is not available.

ev_Overflow

public static final Symbol ev_Overflow

The SignalDetector signal buffer has overflowed. A non-transactional event is delivered to onOverflow.

getSignalBuffer returns the signal(s) that has been discarded or null if that information is not available.

See Also:

p_DiscardOldest

ev_Pattern

public static final Symbol[] ev_Pattern

Array of pattern Symbols, indicating a pattern matched event. A non-transactional event with one of these eventIDs is delivered to onPatternMatched.

The EventID indicates which of the patterns was matched. getSignalBuffer returns the signals that matched the pattern.

See Also:

SignalDetectorEvent.getPatternIndex()

ev_RetrieveSignals

public static final Symbol ev_RetrieveSignals

Completion event for retrieveSignals. getSignalBuffer returns the retrieved signals.

ev_SignalDetected

public static final Symbol ev_SignalDetected

A single Signal has been detected. getSignalBuffer()[0] contains the signal.

Note: To enable this event, one should set p_EnabledEvents to contain ev_SignalDetected. However, some SignalDetector resources implement the S.100-R2 specification, which indicates that p_EnabledEvents should be set to contain Esymbol.SD_SingleSignal.

p_Buffering

public static final Symbol p_Buffering

Enable/disable buffering of signals.

valid values: true and false. true enables buffering, false disables buffering.
Default value: true.

Pattern matching requires that this parameter be true.

p_BufferSize

public static final Symbol p_BufferSize

Size of the signal buffer. Read-only parameter containing the number of signals that can be stored in the signal buffer.

See Also:

a_BufferSize

p_DiscardOldest

public static final Symbol p_DiscardOldest

Boolean that indicates whether the oldest signals are discarded when the signal buffer overflows.

Valid values: true and false.
Default value: false.

p_EnabledEvents

public static final Symbol p_EnabledEvents

A Dictionary of SignalGenerator event Symbols, indicating which events are generated and delivered to the application. If a given eventID is not enabled, then no processing is expended to generate or distribute that kind of event.

Value is a Dictionary of non-transactional event Symbols.
Valid keys are the event Symbols:

• ev_Overflow
.
• ev_Pattern[i]
• ev_SignalDetected
.

Valid values: Boolean.TRUE, Boolean.FALSE
Default value = no events.

For a SignalDetectorListener to receive events, the events must be enabled by setting this parameter. This parameter can be set in a ConfigSpec or by setParameters.

Note: This parameter controls the generation of events. The events cannot be delivered unless a SignalDetectorListener is added using addMediaListener.

p_Filter

public static final Symbol p_Filter

Enable/disable pattern filtering.

Value of this parameter is an Array of ev_Pattern[i] Symbols. When a Pattern in the Array is matched, the matched signals are removed from the signal buffer.

p_Duration

public static final Symbol p_Duration

Maximum time duration for retrieving signals in milliseconds. Stop retrieveSignals after this time limit.

Valid values: an int [0, 100000] milliseconds or FOREVER.
Default value: FOREVER

p_InitialTimeout

public static final Symbol p_InitialTimeout

Maximum time limit for first signal. Stop retrieveSignals if the first signal is not detected within this many milliseconds.

Valid values: an Integer [0, 100000] or FOREVER which indicates no limit.
Default value: FOREVER.

p_InterSigTimeout

public static final Symbol p_InterSigTimeout

Maximum time limit between consecutive signals. Stop retrieveSignals if another signal is not detected within this many milliseconds after detecting the previous signal.

Valid values: an Integer [0, 100000] or FOREVER which indicates no limit.
Default value: FOREVER.

p_Mode

public static final Symbol p_Mode

Enable/disable the signal detector. Setting mode to v_Idle disables the signal detector while keeping it allocated. Setting mode to v_Detecting enable the signal detector.

Caution:
setting this value may reset p_Pattern

Valid values: v_Idle or v_Detecting.
Default value: v_Detecting

v_Idle

public static final Symbol v_Idle

value for p_Mode.

v_Detecting

public static final Symbol v_Detecting

value for p_Mode.

p_Pattern

public static final Symbol[] p_Pattern

Each p_Pattern[i] defines a pattern to be matched. An array of Pattern Symbols to be used as keys in a Dictionary. The associated value in the Dictionary should be a String that defines the series of Signals that matches the pattern.

For each p_Pattern[i], the valid value is a pattern String

These parameters may be set in setParameters, or the optargs argument of retrieveSignals.

p_PatternCount

public static final Symbol p_PatternCount

Number of pattern definitions supported by this SignalDetector resource. For p_Pattern[i], i ranges from [0, p_PatternCount].

This is a read-only parameter. The value is implementation dependent.

See Also:

a_PatternCount

q_Pattern

public static final Symbol[] q_Pattern

The array of Pattern Symbols which appear as qualifiers.

q_Pattern[i] is the qualifier in ev_RetrieveSignals when retrieveSignals terminates because that pattern was matched. The contents of the buffer after the patterns were matched are available using getSignalBuffer.

Note: The actual signals that matched the pattern may not be in the buffer due to filtering, overflow (p_DiacardOldest==FALSE), (p_Buffering==FALSE)

q_Duration

public static final Symbol q_Duration

Complete because total duration timeout (p_Duration) exceeded.

q_InitialTimeout

public static final Symbol q_InitialTimeout

Complete because initial signal timeout (p_InitialTimeout) exceeded.

q_InterSigTimeout

public static final Symbol q_InterSigTimeout

Complete because inter signal timeout (p_InterSigTimeout) exceeded.

q_NumSignals

public static final Symbol q_NumSignals

Complete because requested number of signals detected.

rtca_FlushBuffer

public static final Symbol rtca_FlushBuffer

RTC Action to cause the buffer to be flushed.

rtca_Stop

public static final Symbol rtca_Stop

RTC Action to cause the current operation to stop.

rtcc_SignalDetected

public static final Symbol rtcc_SignalDetected

RTC trigger when some signal has been detected.

rtcc_FlushBuffer

public static final Symbol rtcc_FlushBuffer

RTC trigger when buffer has been flushed.

rtcc_RetrieveSignals

public static final Symbol rtcc_RetrieveSignals

RTC trigger when completion event ev_RetrieveSignals was issued.

rtcc_Pattern

public static final Symbol[] rtcc_Pattern

RTC trigger when the corresponding pattern event was issued. The rtcc_Pattern[i] is triggered when the corresponding ev_Pattern[i] event was issued.