|
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.GetOptionCommand
public class GetOptionCommand
Plays the given file, and waits for the user to press one of the given digits. If none of the esacpe digits is pressed while streaming the file this command waits for the specified timeout still waiting for the user to press a digit. Streaming always begins at the beginning.
Returns 0 if no 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, the file extension must not be included in the filename.
StreamFileCommand
,
Serialized FormConstructor Summary | |
---|---|
GetOptionCommand(java.lang.String file,
java.lang.String escapeDigits)
Creates a new GetOptionCommand with a default timeout of 5 seconds. |
|
GetOptionCommand(java.lang.String file,
java.lang.String escapeDigits,
long timeout)
Creates a new GetOptionCommand with the given timeout. |
Method Summary | |
---|---|
java.lang.String |
buildCommand()
Returns a string suitable to be sent to asterisk. |
java.lang.String |
getEscapeDigits()
Returns the digits that the user is expected to press. |
java.lang.String |
getFile()
Returns the name of the file to stream. |
long |
getTimeout()
Returns the timeout to wait if none of the defined esacpe digits was presses while streaming. |
void |
setEscapeDigits(java.lang.String escapeDigits)
Sets the digits that the user is expected to press. |
void |
setFile(java.lang.String file)
Sets the name of the file to stream. |
void |
setTimeout(long timeout)
Sets the timeout to wait if none of the defined esacpe digits was presses while 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 GetOptionCommand(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 the user is expected to
press.public GetOptionCommand(java.lang.String file, java.lang.String escapeDigits, long timeout)
file
- the name of the file to stream, must not include extension.escapeDigits
- contains the digits that the user is expected to
press.timeout
- the timeout in milliseconds to wait if none of the defined
esacpe digits was presses while 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 the user is expected to press.public long getTimeout()
public void setTimeout(long timeout)
timeout
- the timeout in milliks,seconds.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 |