org.mobicents.media.control.mgcp.pkg.au.pc

Class PlayCollect

java.lang.Object

org.mobicents.media.control.mgcp.pkg.AbstractMgcpSignal

org.mobicents.media.control.mgcp.pkg.au.pc.PlayCollect

All Implemented Interfaces:

MgcpEventSubject, MgcpSignal

public class PlayCollect
extends AbstractMgcpSignal

Plays a prompt and collects DTMF digits entered by a user.

If no digits are entered or an invalid digit pattern is entered, the user may be reprompted and given another chance to enter a correct pattern of digits. The following digits are supported: 0-9, *, #, A, B, C, D.

By default PlayCollect does not play an initial prompt, makes only one attempt to collect digits, and therefore functions as a simple Collect operation.
Various special purpose keys, key sequences, and key sets can be defined for use during the PlayCollect operation.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Field Summary

Fields inherited from class org.mobicents.media.control.mgcp.pkg.AbstractMgcpSignal

executing

Constructor Summary

Constructors

Constructor and Description
PlayCollect(Player player, DtmfDetector detector, int requestId, Map<String,String> parameters, com.google.common.util.concurrent.ListeningScheduledExecutorService executor)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the executing signal. No action is taken if signal is not executing.
void	execute() Executes the signal.
protected boolean	isParameterSupported(String name)

Methods inherited from class org.mobicents.media.control.mgcp.pkg.AbstractMgcpSignal

equals, forget, getName, getParameter, getRequestId, getSignalType, getSymbol, isExecuting, notify, observe, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayCollect

public PlayCollect(Player player,
           DtmfDetector detector,
           int requestId,
           Map<String,String> parameters,
           com.google.common.util.concurrent.ListeningScheduledExecutorService executor)

Method Detail

isParameterSupported

protected boolean isParameterSupported(String name)

Specified by:

isParameterSupported in class AbstractMgcpSignal

execute

public void execute()

Description copied from interface: MgcpSignal

Executes the signal.

cancel

public void cancel()

Description copied from interface: MgcpSignal

Cancels the executing signal.
No action is taken if signal is not executing.