com.avaya.conferencing.api.acp.control.events
Class DTMFEvent

java.lang.Object
  java.util.EventObject
      com.avaya.conferencing.api.acp.control.events.DTMFEvent

All Implemented Interfaces:

java.io.Serializable

public class DTMFEvent
extends java.util.EventObject

A DTMF event.

Since:

5.1.0.0.29

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

DTMFEvent(EndPoint source, java.lang.String dtmf, long sequenceNumber)
Constructs a prototypical Event.

DTMFEvent(EndPoint source, java.lang.String dtmf, long sequenceNumber, double signalToNoiseRatio)
Constructs a prototypical Event.

Method Summary

java.lang.String	getDtmf() Method getDtmf returns the DTMF of this DTMFEvent object.
long	getSequenceNumber() Returns the sequence number of this DTMF event.
java.lang.Double	getSignalToNoiseRatio() Returns the signal-to-noise ratio of the DTMF event or null if this information is not available.
EndPoint	getSource() The EndPoint which generated this Event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DTMFEvent

public DTMFEvent(EndPoint source,
                 java.lang.String dtmf,
                 long sequenceNumber)

Constructs a prototypical Event.

Parameters:

source - The object on which the Event initially occurred.

dtmf - The DTMF event.

sequenceNumber - For any individual source object, the sequence number must be an increased by at least one for each DTMF event generated.

Throws:

java.lang.IllegalArgumentException - if source is null.

Since:

5.1.0.0.29

DTMFEvent

public DTMFEvent(EndPoint source,
                 java.lang.String dtmf,
                 long sequenceNumber,
                 double signalToNoiseRatio)

Constructs a prototypical Event.

Parameters:

source - The object on which the Event initially occurred.

dtmf - The DTMF event.

sequenceNumber - For any individual source object, the sequence number must be an increased by at least one for each DTMF event generated.

signalToNoiseRatio - The signal-to-noise ratio of the DTMF digit(s) in the event.

Throws:

java.lang.IllegalArgumentException - if source is null.

Since:

5.1.1.0.1

Method Detail

getDtmf

public java.lang.String getDtmf()

Method getDtmf returns the DTMF of this DTMFEvent object.

Returns:

the dtmf (type String) of this DTMFEvent object.

Since:

5.1.0.0.29

getSequenceNumber

public long getSequenceNumber()

Returns the sequence number of this DTMF event. Each source instance must maintain a DTMF sequence number that is increased either on each event, or as time passes. This sequence number can be used to ensure that DTMF events are interpreted in the correct order. The sequence number need not be a positive number. The only guarantee is that for any fixed source object, the sequence number can be used to establish the sequence of events.

Returns:

The sequence number of this event.

Since:

5.1.0.0.29

getSignalToNoiseRatio

public java.lang.Double getSignalToNoiseRatio()

Returns the signal-to-noise ratio of the DTMF event or null if this information is not available.

Returns:

the signal-to-noise ratio of the DTMF event or null if this information is not available.

Since:

5.1.1.0.1

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject

Since:

5.1.0.0.29

getSource

public EndPoint getSource()

The EndPoint which generated this Event.

Overrides:

getSource in class java.util.EventObject

Returns:

The EndPoint which generated this Event.

Since:

5.1.0.0.29