org.asteriskjava.fastagi.command

Class ControlStreamFileCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.ControlStreamFileCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class ControlStreamFileCommand
extends AbstractAgiCommand

AGI Command: CONTROL STREAM FILE

Send the given file, allowing playback to be controlled by the given digits, if any. Use double quotes for the digits if you wish none to be permitted. If offsetms is provided then the audio will seek to offsetms before play starts. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed, or -1 on error or if the channel was disconnected. Returns the position where playback was terminated as endpos.

See: AGI Command CONTROL STREAM FILE (Asterisk 18)

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ControlStreamFileCommand(String file) Creates a new ControlStreamFileCommand, streaming from the beginning.
ControlStreamFileCommand(String file, String escapeDigits) Creates a new ControlStreamFileCommand, streaming from the beginning.
ControlStreamFileCommand(String file, String escapeDigits, int offset) Creates a new ControlStreamFileCommand, streaming from the given offset.
ControlStreamFileCommand(String file, String escapeDigits, int offset, String forwardDigit, String rewindDigit, String pauseDigit) Creates a new ControlStreamFileCommand, streaming from the given offset.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getEscapeDigits() Returns the digits that allow the user to interrupt this command.
String	getFile() Returns the name of the file to stream.
String	getForwardDigit() Returns the digit for fast-forward.
int	getOffset() Returns the offset samples to skip before streaming.
String	getPauseDigit() Retruns the digit for pause and unpause.
String	getRewindDigit() Returns the digit for rewind.
void	setControlDigits(String forwardDigit, String rewindDigit) Sets the control digits for fast-forward and rewind.
void	setControlDigits(String forwardDigit, String rewindDigit, String pauseDigit) Sets the control digits for fast-forward, rewind and pause.
void	setEscapeDigits(String escapeDigits) Sets the digits that allow the user to interrupt this command.
void	setFile(String file) Sets the name of the file to stream.
void	setOffset(int offset) Sets the offset samples to skip before streaming.

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

ControlStreamFileCommand

public ControlStreamFileCommand(String file)

Creates a new ControlStreamFileCommand, streaming from the beginning. It uses the default digit "#" for forward and "*" for rewind and does not support pausing.

Parameters:

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

ControlStreamFileCommand

public ControlStreamFileCommand(String file,
                                String escapeDigits)

Creates a new ControlStreamFileCommand, streaming from the beginning. It uses the default digit "#" for forward and "*" for rewind and does not support pausing.

Parameters:

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

escapeDigits - contains the digits that allow the user to interrupt this command.

ControlStreamFileCommand

public ControlStreamFileCommand(String file,
                                String escapeDigits,
                                int offset)

Creates a new ControlStreamFileCommand, streaming from the given offset. It uses the default digit "#" for forward and "*" for rewind and does not support pausing.

Parameters:

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

escapeDigits - contains the digits that allow the user to interrupt this command. May be null if you don't want the user to interrupt.

offset - the offset samples to skip before streaming.

ControlStreamFileCommand

public ControlStreamFileCommand(String file,
                                String escapeDigits,
                                int offset,
                                String forwardDigit,
                                String rewindDigit,
                                String pauseDigit)

Creates a new ControlStreamFileCommand, streaming from the given offset. It allows the user to pause streaming by pressing the pauseDigit.

Parameters:

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

escapeDigits - contains the digits that allow the user to interrupt this command. May be null if you don't want the user to interrupt.

offset - the offset samples to skip before streaming.

forwardDigit - the digit for fast-forward.

rewindDigit - the digit for rewind.

pauseDigit - the digit for pause and unpause.

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.

getEscapeDigits

public String getEscapeDigits()

Returns the digits that allow the user to interrupt this command.

Returns:

the digits that allow the user to interrupt this command.

setEscapeDigits

public void setEscapeDigits(String escapeDigits)

Sets the digits that allow the user to interrupt this command.

Parameters:

escapeDigits - the digits that allow the user to interrupt this command or null for none.

getOffset

public int getOffset()

Returns the offset samples to skip before streaming.

Returns:

the offset samples to skip before streaming.

setOffset

public void setOffset(int offset)

Sets the offset samples to skip before streaming.

Parameters:

offset - the offset samples to skip before streaming.

getForwardDigit

public String getForwardDigit()

Returns the digit for fast-forward.

Returns:

the digit for fast-forward.

getRewindDigit

public String getRewindDigit()

Returns the digit for rewind.

Returns:

the digit for rewind.

getPauseDigit

public String getPauseDigit()

Retruns the digit for pause and unpause.

Returns:

the digit for pause and unpause.

setControlDigits

public void setControlDigits(String forwardDigit,
                             String rewindDigit)

Sets the control digits for fast-forward and rewind.

Parameters:

forwardDigit - the digit for fast-forward.

rewindDigit - the digit for rewind.

setControlDigits

public void setControlDigits(String forwardDigit,
                             String rewindDigit,
                             String pauseDigit)

Sets the control digits for fast-forward, rewind and pause.

Parameters:

forwardDigit - the digit for fast-forward.

rewindDigit - the digit for rewind.

pauseDigit - the digit for pause and unpause.

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.