JSR-043: JTAPI-1.4

javax.telephony.media
Interface SignalGenerator

All Superinterfaces:
MediaConstants, Resource, ResourceConstants, SignalConstants, SignalGeneratorConstants
All Known Implementing Classes:
BasicMediaService

public interface SignalGenerator
extends Resource, SignalGeneratorConstants

Defines a method for sending signals out to the telephony network. These methods generate the familiar DTMF tones.

Vendor-specific extensions may be used to generate other tones.

Since:
JTAPI-1.3

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_Duration, q_Standard, q_Stop
 
Fields inherited from interface javax.telephony.media.SignalGeneratorConstants
ev_SendSignals, v_Class
 
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
 SignalGeneratorEvent sendSignals(java.lang.String signals, RTC[] rtc, java.util.Dictionary optargs)
          Transmit a series of signals out the Terminal to the network.
 SignalGeneratorEvent sendSignals(Symbol[] signals, RTC[] rtc, java.util.Dictionary optargs)
          Transmit a series of signals out the Terminal to the network.
 

Method Detail

sendSignals

public SignalGeneratorEvent sendSignals(java.lang.String signals,
                                        RTC[] rtc,
                                        java.util.Dictionary optargs)
                                 throws MediaResourceException
Transmit a series of signals out the Terminal to the network.

Each signal is defined by a single char in the String.

Note: The AIA inserts spaces for presentation at the S.200/S.300 layers

Parameters:
signals - an String containing chars representing each signal.
rtc - an array of RTC objects that controls this transactions.
optargs - a Dictionary of optional arguments
Returns:
a SignalGeneratorEvent.
Throws:
MediaResourceException - if this request fails.
DisconnectedException - if Terminal is disconnected.

sendSignals

public SignalGeneratorEvent sendSignals(Symbol[] signals,
                                        RTC[] rtc,
                                        java.util.Dictionary optargs)
                                 throws MediaResourceException
Transmit a series of signals out the Terminal to the network.

Each signal is defined by a Symbol in the Symbol[].

Note: This method may be less efficient than using the String form of sendSignals.

Parameters:
signals - an array of Symbols that defines a signal.
rtc - an array of RTC objects that controls this transactions.
optargs - a Dictionary of optional arguments
Returns:
a SignalGeneratorEvent
Throws:
MediaResourceException - if this request fails.
DisconnectedException - if Terminal is disconnected.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org