|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.asteriskjava.fastagi.command.AbstractAgiCommand
org.asteriskjava.fastagi.command.StreamFileCommand
public class StreamFileCommand
Plays the given file, allowing playback to be interrupted by the given digits, if any.
If offset is provided then the audio will seek to sample offset 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.
Remember, filename follows the same conventions and uses the same file path as dialplan applications like Playback or Background. The file extension must not be included in the filename.
Constructor Summary | |
---|---|
StreamFileCommand(java.lang.String file)
Creates a new StreamFileCommand, streaming from the beginning. |
|
StreamFileCommand(java.lang.String file,
java.lang.String escapeDigits)
Creates a new StreamFileCommand, streaming from the beginning. |
|
StreamFileCommand(java.lang.String file,
java.lang.String escapeDigits,
int offset)
Creates a new StreamFileCommand, streaming from the given offset. |
Method Summary | |
---|---|
java.lang.String |
buildCommand()
Returns a string suitable to be sent to asterisk. |
java.lang.String |
getEscapeDigits()
Returns the digits that allow the user to interrupt this command. |
java.lang.String |
getFile()
Returns the name of the file to stream. |
int |
getOffset()
Returns the offset samples to skip before streaming. |
void |
setEscapeDigits(java.lang.String escapeDigits)
Sets the digits that allow the user to interrupt this command. |
void |
setFile(java.lang.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, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public StreamFileCommand(java.lang.String file)
file
- the name of the file to stream, must not include extension.public StreamFileCommand(java.lang.String file, java.lang.String escapeDigits)
file
- the name of the file to stream, must not include extension.escapeDigits
- contains the digits that allow the user to interrupt
this command.public StreamFileCommand(java.lang.String file, java.lang.String escapeDigits, int offset)
file
- the name of the file to stream, must not include extension.escapeDigits
- contains the digits that allow the user to interrupt
this command. Maybe null
if you don't want the
user to interrupt.offset
- the offset samples to skip before streaming.Method Detail |
---|
public java.lang.String getFile()
public void setFile(java.lang.String file)
file
- the name of the file to stream, must not include extension.public java.lang.String getEscapeDigits()
public void setEscapeDigits(java.lang.String escapeDigits)
escapeDigits
- the digits that allow the user to interrupt this
command or null
for none.public int getOffset()
public void setOffset(int offset)
offset
- the offset samples to skip before streaming.public java.lang.String buildCommand()
AgiCommand
buildCommand
in interface AgiCommand
buildCommand
in class AbstractAgiCommand
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |