javax.telephony.media
Class RTC

java.lang.Object
  |
  +--javax.telephony.media.RTC

All Implemented Interfaces:

java.io.Serializable

public class RTC

extends java.lang.Object

implements java.io.Serializable

An RTC (Run Time Control) object associates a trigger condition with some action. When the Resource identified by the trigger condition emits an event that corresponds to that condition, the action command is sent to the Resource whose operation is being controlled by the RTC.

The RTC trigger Symbols are a subset of the event Symbols. The events available as RTC triggers are defined by the resource that generates them.

• The name of an RTC trigger has the form: rtcc_<EventName>.
• The name of an RTC action has the form: rtca_<CommandName>.

For example:

 static RTC speedUp = new RTC(SignalDetector.rtcc_Pattern[2],
                                      Player.rtca_SpeedUp);
        RTC[] rtcs = {speedUp};
        playEvent = play(..., rtcs, ...);

In this case, when the signal detector resource matches Pattern 2, the Player resource recieves the Player.rtca_speedUp command.

RTC objects typically appear in media transaction commands as elements of the RTC[] rtc argument.

Since:

JTAPI-1.3

See Also:

Serialized Form

Field Summary

static RTC	ASR_StopPlay The common RTC to stop a prompt when ASR recognises voice energy.
static RTC	SigDet_StopPlay The common RTC to stop a prompt when a DTMF is detected.
static RTC	SigDet_StopRecord The common RTC to stop a recording when a DTMF is detected.

Constructor Summary

RTC(Symbol trigger, Symbol action)
Create an RTC object linking the trigger condition to the action command.

Method Summary

boolean	equals(java.lang.Object other) Two RTCs are equal if both the trigger and action Symbols (respectively) are equal.
Symbol	getAction() Return the Symbol that defines action for this RTC.
Symbol	getTrigger() Return the Symbol that defines the trigger condition for this RTC.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SigDet_StopPlay

public static final RTC SigDet_StopPlay

The common RTC to stop a prompt when a DTMF is detected.

SigDet_StopRecord

public static final RTC SigDet_StopRecord

The common RTC to stop a recording when a DTMF is detected.

ASR_StopPlay

public static final RTC ASR_StopPlay

The common RTC to stop a prompt when ASR recognises voice energy.

Constructor Detail

RTC

public RTC(Symbol trigger,
           Symbol action)

Create an RTC object linking the trigger condition to the action command.

The Symbols used to define an RTC trigger are a subset of the EventID Symbols. The applicable RTC triggers are defined by the resource that generates the event.

• The name of an RTC trigger has the form: rtcc_<EventName>.
• The name of an RTC action has the form: rtca_<CommandName>.

Parameters:

trigger - a Symbol, typically named with rtcc_

action - a Symbol, typically named with rtca_

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Two RTCs are equal if both the trigger and action Symbols (respectively) are equal.

Overrides:

equals in class java.lang.Object

Parameters:

other - the Object to be compared to this RTC Object

Returns:

true iff both RTCs have the same trigger and action Symbols.

getTrigger

public Symbol getTrigger()

Return the Symbol that defines the trigger condition for this RTC.

Returns:

the Symbol that defines the trigger condition for this RTC.

getAction

public Symbol getAction()

Return the Symbol that defines action for this RTC.

Returns:

the Symbol that defines action for this RTC.