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

Enum SignalParameters

java.lang.Object

java.lang.Enum<SignalParameters>

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

All Implemented Interfaces:

Serializable, Comparable<SignalParameters>

public enum SignalParameters
extends Enum<SignalParameters>

The PlayAnnouncement, PlayRecord, and PlayCollect events may each be qualified by a string of parameters, most of which are optional. Where appropriate, parameters default to reasonable values.

The only event with a required parameter is PlayAnnouncement. If a Play-Announcement event is not provided with a parameter specifying some form of playable audio an error is returned to the application.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOUNCEMENT
CLEAR_DIGIT_BUFFER
DIGIT_PATTERN
DURATION
END_INPUT_KEY
EXTRA_DIGIT_TIMER
FAILURE_ANNOUNCEMENT
FIRST_DIGIT_TIMER
INCLUDE_END_INPUT_KEY
INITIAL_PROMPT
INTER_DIGIT_TIMER
INTERVAL
ITERATIONS
MAXIMUM_NUM_DIGITS
MINIMUM_NUM_DIGITS
NO_DIGITS_REPROMPT
NO_SPEECH_REPROMTP
NON_INTERRUPTIBLE_PLAY
NUMBER_OF_ATTEMPTS
POSITION_KEY
POST_SPEECH_TIMER
PRE_SPEECH_TIMER
RECORD_ID
REINPUT_KEY
REPROMPT
RESTART_KEY
RETURN_KEY
SIGNAL
SPEED
START_INPUT_KEY
STOP_KEY
SUCCESS_ANNOUNCEMENT
TOTAL_RECORDING_LENGTH_TIMER
VOLUME

Method Summary

Methods

Modifier and Type	Method and Description
static SignalParameters	fromSymbol(String symbol)
String	symbol()
static SignalParameters	valueOf(String name) Returns the enum constant of this type with the specified name.
static SignalParameters[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANNOUNCEMENT

public static final SignalParameters ANNOUNCEMENT

INITIAL_PROMPT

public static final SignalParameters INITIAL_PROMPT

REPROMPT

public static final SignalParameters REPROMPT

NO_DIGITS_REPROMPT

public static final SignalParameters NO_DIGITS_REPROMPT

NO_SPEECH_REPROMTP

public static final SignalParameters NO_SPEECH_REPROMTP

FAILURE_ANNOUNCEMENT

public static final SignalParameters FAILURE_ANNOUNCEMENT

SUCCESS_ANNOUNCEMENT

public static final SignalParameters SUCCESS_ANNOUNCEMENT

NON_INTERRUPTIBLE_PLAY

public static final SignalParameters NON_INTERRUPTIBLE_PLAY

ITERATIONS

public static final SignalParameters ITERATIONS

INTERVAL

public static final SignalParameters INTERVAL

DURATION

public static final SignalParameters DURATION

SPEED

public static final SignalParameters SPEED

VOLUME

public static final SignalParameters VOLUME

CLEAR_DIGIT_BUFFER

public static final SignalParameters CLEAR_DIGIT_BUFFER

MAXIMUM_NUM_DIGITS

public static final SignalParameters MAXIMUM_NUM_DIGITS

MINIMUM_NUM_DIGITS

public static final SignalParameters MINIMUM_NUM_DIGITS

DIGIT_PATTERN

public static final SignalParameters DIGIT_PATTERN

FIRST_DIGIT_TIMER

public static final SignalParameters FIRST_DIGIT_TIMER

INTER_DIGIT_TIMER

public static final SignalParameters INTER_DIGIT_TIMER

EXTRA_DIGIT_TIMER

public static final SignalParameters EXTRA_DIGIT_TIMER

PRE_SPEECH_TIMER

public static final SignalParameters PRE_SPEECH_TIMER

POST_SPEECH_TIMER

public static final SignalParameters POST_SPEECH_TIMER

TOTAL_RECORDING_LENGTH_TIMER

public static final SignalParameters TOTAL_RECORDING_LENGTH_TIMER

RESTART_KEY

public static final SignalParameters RESTART_KEY

REINPUT_KEY

public static final SignalParameters REINPUT_KEY

RETURN_KEY

public static final SignalParameters RETURN_KEY

POSITION_KEY

public static final SignalParameters POSITION_KEY

STOP_KEY

public static final SignalParameters STOP_KEY

START_INPUT_KEY

public static final SignalParameters START_INPUT_KEY

END_INPUT_KEY

public static final SignalParameters END_INPUT_KEY

INCLUDE_END_INPUT_KEY

public static final SignalParameters INCLUDE_END_INPUT_KEY

NUMBER_OF_ATTEMPTS

public static final SignalParameters NUMBER_OF_ATTEMPTS

RECORD_ID

public static final SignalParameters RECORD_ID

SIGNAL

public static final SignalParameters SIGNAL

Method Detail

values

public static SignalParameters[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SignalParameters c : SignalParameters.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SignalParameters valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

symbol

public String symbol()

fromSymbol

public static final SignalParameters fromSymbol(String symbol)