org.asteriskjava.fastagi.command

Class RecordFileCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.RecordFileCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class RecordFileCommand
extends AbstractAgiCommand

AGI Command: RECORD FILE

Records to a given file.

See: AGI Command RECORD FILE (Asterisk 18)

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RecordFileCommand(String file, String format, String escapeDigits, int timeout) Creates a new RecordFileCommand.
RecordFileCommand(String file, String format, String escapeDigits, int timeout, int offset, boolean beep, int maxSilence) Creates a new RecordFileCommand.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
boolean	getBeep() Returns true if a beep should be played before recording.
String	getEscapeDigits() Returns the digits that allow the user to end recording.
String	getFile() Returns the name of the file to stream.
String	getFormat() Returns the format of the file to be recorded, for example "wav".
int	getOffset() Returns the offset samples to skip.
int	getTimeout() Returns the maximum record time in milliseconds.
void	setBeep(boolean beep) Set to true to play a beep before recording.
void	setEscapeDigits(String escapeDigits) Sets the digits that allow the user to end recording.
void	setFile(String file) Sets the name of the file to stream.
void	setFormat(String format) Sets the format of the file to be recorded, for example "wav".
void	setOffset(int offset) Sets the offset samples to skip.
void	setTimeout(int timeout) Sets the maximum record time in milliseconds.

Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand

escapeAndQuote, escapeAndQuote, setAsteriskVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordFileCommand

public RecordFileCommand(String file,
                         String format,
                         String escapeDigits,
                         int timeout)

Creates a new RecordFileCommand.

Parameters:

file - the name of the file to stream, must not include extension.

format - the format of the file to be recorded, for example "wav".

escapeDigits - contains the digits that allow the user to end recording.

timeout - the maximum record time in milliseconds, or -1 for no timeout.

RecordFileCommand

public RecordFileCommand(String file,
                         String format,
                         String escapeDigits,
                         int timeout,
                         int offset,
                         boolean beep,
                         int maxSilence)

Creates a new RecordFileCommand.

Parameters:

file - the name of the file to stream, must not include extension.

format - the format of the file to be recorded, for example "wav".

escapeDigits - contains the digits that allow the user to end recording.

timeout - the maximum record time in milliseconds, or -1 for no timeout.

offset - the offset samples to skip.

beep - true if a beep should be played before recording.

maxSilence - The amount of silence (in seconds) to allow before returning despite the lack of dtmf digits or reaching timeout.

Method Detail

getFile

public String getFile()

Returns the name of the file to stream.

Returns:

the name of the file to stream.

setFile

public void setFile(String file)

Sets the name of the file to stream.

Parameters:

file - the name of the file to stream, must not include extension.

getFormat

public String getFormat()

Returns the format of the file to be recorded, for example "wav".

Returns:

the format of the file to be recorded, for example "wav".

setFormat

public void setFormat(String format)

Sets the format of the file to be recorded, for example "wav".

Parameters:

format - the format of the file to be recorded, for example "wav".

getEscapeDigits

public String getEscapeDigits()

Returns the digits that allow the user to end recording.

Returns:

the digits that allow the user to end recording.

setEscapeDigits

public void setEscapeDigits(String escapeDigits)

Sets the digits that allow the user to end recording.

Parameters:

escapeDigits - the digits that allow the user to end recording or null for none.

getTimeout

public int getTimeout()

Returns the maximum record time in milliseconds.

Returns:

the maximum record time in milliseconds.

setTimeout

public void setTimeout(int timeout)

Sets the maximum record time in milliseconds.

Parameters:

timeout - the maximum record time in milliseconds, or -1 for no timeout.

getOffset

public int getOffset()

Returns the offset samples to skip.

Returns:

the offset samples to skip.

setOffset

public void setOffset(int offset)

Sets the offset samples to skip.

Parameters:

offset - the offset samples to skip.

getBeep

public boolean getBeep()

Returns true if a beep should be played before recording.

Returns:

true if a beep should be played before recording, false if not.

setBeep

public void setBeep(boolean beep)

Set to true to play a beep before recording.

Parameters:

beep - true if a beep should be played before recording, false if not.

buildCommand

public String buildCommand()

Description copied from interface: AgiCommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in interface AgiCommand

Specified by:

buildCommand in class AbstractAgiCommand

Returns:

a string suitable to be sent to asterisk.