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

Class PlayRecordContext

java.lang.Object

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

public class PlayRecordContext
extends Object

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Constructor Summary

Constructors

Constructor and Description
PlayRecordContext(Map<String,String> parameters)

Method Summary

Methods

Modifier and Type	Method and Description
int	getAttempt()
boolean	getClearDigitBuffer() If set to true, clears the digit buffer before playing the initial prompt.
char	getEndInputKey() Specifies a key that signals the end of digit collection or voice recording.
Playlist	getFailureAnnouncement()
Playlist	getInitialPrompt()
boolean	getNonInterruptibleAudio() If set to true, initial prompt is not interruptible by either voice or digits.
Playlist	getNoSpeechReprompt()
int	getNumberOfAttempts() The number of attempts the user needed to enter a valid digit pattern or to make a recording.
char	getPositionKey() Defines a key with the following action.
int	getPostSpeechTimer() The amount of silence necessary after the end of the last speech segment for the recording to be considered complete. Specified in units of 100 milliseconds.
int	getPreSpeechTimer() The amount of time to wait for the user to initially speak. Specified in units of 100 milliseconds.Defaults to 30 (3 seconds).
String	getRecordId() Gets the path where the recording will be stored.
char	getReinputKey() Defines a key sequence consisting of a command key optionally followed by zero or more keys.
Playlist	getReprompt()
char	getRestartKey() Defines a key sequence consisting of a command key optionally followed by zero or more keys.
int	getReturnCode()
char	getReturnKey() Defines a key sequence consisting of a command key optionally followed by zero or more keys.
char	getStopKey() Defines a key with the following action.
Playlist	getSuccessAnnouncement()
char	getTone()
int	getTotalRecordingLengthTimer() The maximum allowable length of the recording, not including pre or post speech silence. Specified in units of 100 milliseconds.
boolean	hasFailureAnnouncement()
boolean	hasMoreAttempts()
boolean	hasRecording() Gets whether the recording file exists in the file system.
boolean	hasSuccessAnnouncement()
boolean	isSpeechDetected()
protected void	newAttempt() Resets the collected digits and increments the attempts counter.
protected void	setReturnCode(int returnCode)
void	setSpeechDetected(boolean speechDetected)
void	setTone(char tone)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayRecordContext

public PlayRecordContext(Map<String,String> parameters)

Method Detail

getInitialPrompt

public Playlist getInitialPrompt()

getReprompt

public Playlist getReprompt()

getNoSpeechReprompt

public Playlist getNoSpeechReprompt()

getFailureAnnouncement

public Playlist getFailureAnnouncement()

hasFailureAnnouncement

public boolean hasFailureAnnouncement()

getSuccessAnnouncement

public Playlist getSuccessAnnouncement()

hasSuccessAnnouncement

public boolean hasSuccessAnnouncement()

getRecordId

public String getRecordId()

Gets the path where the recording will be stored.

Returns:

hasRecording

public boolean hasRecording()

Gets whether the recording file exists in the file system.

Returns:

getNonInterruptibleAudio

public boolean getNonInterruptibleAudio()

If set to true, initial prompt is not interruptible by either voice or digits.

Defaults to false. Valid values are the text strings "true" and "false".

Returns:

getClearDigitBuffer

public boolean getClearDigitBuffer()

If set to true, clears the digit buffer before playing the initial prompt.

Defaults to false. Valid values are the text strings "true" and "false".

Returns:

getPreSpeechTimer

public int getPreSpeechTimer()

The amount of time to wait for the user to initially speak.
Specified in units of 100 milliseconds.Defaults to 30 (3 seconds).

Returns:

The pre-speech timer duration.

getPostSpeechTimer

public int getPostSpeechTimer()

The amount of silence necessary after the end of the last speech segment for the recording to be considered complete.
Specified in units of 100 milliseconds. Defaults to 20 (2 seconds).

Returns:

The pre-speech timer duration.

getTotalRecordingLengthTimer

public int getTotalRecordingLengthTimer()

The maximum allowable length of the recording, not including pre or post speech silence.
Specified in units of 100 milliseconds. This parameter is mandatory.

Returns:

The value of the recording length.

getRestartKey

public char getRestartKey()

Defines a key sequence consisting of a command key optionally followed by zero or more keys. This key sequence has the following action: discard any digits collected or recording in progress, replay the prompt, and resume digit collection or recording.

No default. An application that defines more than one command key sequence, will typically use the same command key for all command key sequences.

If more than one command key sequence is defined, then all key sequences must consist of a command key plus at least one other key.

Returns:

getReinputKey

public char getReinputKey()

Defines a key sequence consisting of a command key optionally followed by zero or more keys. This key sequence has the following action: discard any digits collected or recordings in progress and resume digit collection or recording.

No default.

An application that defines more than one command key sequence, will typically use the same command key for all command key sequences.

If more than one command key sequence is defined, then all key sequences must consist of a command key plus at least one other key.

Returns:

getReturnKey

public char getReturnKey()

Defines a key sequence consisting of a command key optionally followed by zero or more keys. This key sequence has the following action: terminate the current event and any queued event and return the terminating key sequence to the call processing agent.

No default. An application that defines more than one command key sequence, will typically use the same command key for all command key sequences.

If more than one command key sequence is defined, then all key sequences must consist of a command key plus at least one other key.

Returns:

getPositionKey

public char getPositionKey()

Defines a key with the following action. Stop playing the current announcement and resume playing at the beginning of the first, last, previous, next, or the current segment of the announcement.

No default. The actions for the position key are fst, lst, prv, nxt, and cur.

Returns:

getStopKey

public char getStopKey()

Defines a key with the following action. Terminate playback of the announcement.

No default.

Returns:

getEndInputKey

public char getEndInputKey()

Specifies a key that signals the end of digit collection or voice recording.

The default end input key is the # key. To specify that no End Input Key be used the parameter is set to the string "null".

The default behavior not to return the End Input Key in the digits returned to the call agent. This behavior can be overridden by the Include End Input Key (eik) parameter.

Returns:

getNumberOfAttempts

public int getNumberOfAttempts()

The number of attempts the user needed to enter a valid digit pattern or to make a recording.

Defaults to 1. Also used as a return parameter to indicate the number of attempts the user made.

Returns:

getTone

public char getTone()

setTone

public void setTone(char tone)

getAttempt

public int getAttempt()

hasMoreAttempts

public boolean hasMoreAttempts()

getReturnCode

public int getReturnCode()

setReturnCode

protected void setReturnCode(int returnCode)

isSpeechDetected

public boolean isSpeechDetected()

setSpeechDetected

public void setSpeechDetected(boolean speechDetected)

newAttempt

protected void newAttempt()

Resets the collected digits and increments the attempts counter.