com.avaya.jtapi.tsapi
Interface LucentV5TerminalConnectionEx

All Superinterfaces:

CallControlTerminalConnection, ITsapiTerminalConnection, LucentTerminalConnection, LucentV5TerminalConnection, MediaTerminalConnection, TerminalConnection

All Known Implementing Classes:

LucentV5TerminalConnectionExImpl

public interface LucentV5TerminalConnectionEx

extends LucentV5TerminalConnection

this interface extends the LucentV5TerminalConnection interface with features specific to DEFINITY G3 PBX Driver Version 5 private data - specifically, with a method that provides the ability to exert more control over how DTMF (dual tone multi-function) tones are generated. When a Provider is bound to a DEFINITY switch which supports V5 private data, this interface may be used to access this additional capability.

Field Summary

Fields inherited from interface com.avaya.jtapi.tsapi.LucentTerminalConnection

DR_CALL_CLASSIFIER, DR_NONE, DR_TONE_GENERATOR

Fields inherited from interface javax.telephony.TerminalConnection

ACTIVE, DROPPED, IDLE, PASSIVE, RINGING, UNKNOWN

Fields inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection

BRIDGED, DROPPED, HELD, IDLE, INUSE, RINGING, TALKING, UNKNOWN

Fields inherited from interface javax.telephony.media.MediaTerminalConnection

AVAILABLE, NOACTIVITY, PLAYING, RECORDING, UNAVAILABLE

Method Summary

void

generateDtmf(java.lang.String digits, int toneDuration, int pauseDuration) this method provides the ability to exert more control over how DTMF (dual tone multi-function) tones are generated - specifically, it enables an application to control the duration of the DTMF tones and the length of delay between tones.

Methods inherited from interface com.avaya.jtapi.tsapi.LucentV5TerminalConnection

listenHold, listenHold, listenUnhold, listenUnhold

Methods inherited from interface com.avaya.jtapi.tsapi.LucentTerminalConnection

leave

Methods inherited from interface javax.telephony.TerminalConnection

answer, getCapabilities, getConnection, getState, getTerminal, getTerminalConnectionCapabilities

Methods inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection

getCallControlState, hold, join, leave, unhold

Methods inherited from interface javax.telephony.media.MediaTerminalConnection

generateDtmf, getMediaAvailability, getMediaState, setDtmfDetection, startPlaying, startRecording, stopPlaying, stopRecording, useDefaultMicrophone, useDefaultSpeaker, usePlayURL, useRecordURL

Method Detail

generateDtmf

public void generateDtmf(java.lang.String digits,
                         int toneDuration,
                         int pauseDuration)
                  throws TsapiMethodNotSupportedException,
                         TsapiResourceUnavailableException,
                         TsapiInvalidStateException

this method provides the ability to exert more control over how DTMF (dual tone multi-function) tones are generated - specifically, it enables an application to control the duration of the DTMF tones and the length of delay between tones.

Parameters:

digits - a String with the digits to be translated into DTMF tones. The following constraints apply:

• the maximum number of DTMF tones that may be sent for a DEFINITY G3 is 32;
• the call must be in an established state;
• the allowed DTMF tones are digits 0-9 and # and *.

toneDuration - an int which specifies the duration of each DTMF tone, in hundredths of a second (for example, 10 means 1/10 of a second). Valid range of values accepted by the DEFINITY G3 for this parameter is from 6 to 35 (.06 to 0.35 seconds). The default duration is .35 seconds (350 milliseconds).

pauseDuration - an int which specifies the duration of the pause between each DTMF tone played, in one hundredths of a second. Valid range of values accepted by the DEFINITY G3 for this parameter is from 4 to 10 (0.04 to 0.10 seconds). The default duration is .10 seconds (100 milliseconds).

Throws:

TsapiMethodNotSupportedException - provider is not a DEFINITY G3.

TsapiResourceUnavailableException - this service is requested on a DEFINITY G3 administered as a release earlier than G3V4.

TsapiInvalidStateException - either

• the service is requested on a call that is currently receiving switch-provided tone, such as dial tone, busy tone, ringback tone, intercept tone, Music-on-Hold/Delay, etc. The call must be in an established state in order to send DTMF tones, or,
• invalid callID is specified in sender or receivers.

TsapiInvalidArgumentException - either

• The tones parameter has length equal to 0 or greater than 32 or invalid characters are specified in tones, or
• a mandatory parameter is missing.

TsapiPlatformException - invalid deviceID is specified in sender.