org.asteriskjava.fastagi

Interface AgiChannel

All Known Implementing Classes:

AgiChannelImpl, AgiOperations, BaseAgiScript

public interface AgiChannel

Provides the functionality to send AgiCommands to Asterisk while handling an AgiRequest.
This interface is supposed to be used by AgiScripts for interaction with the Asterisk server.

Version:

$Id$

Author:

srt

Method Summary

Modifier and Type	Method and Description
void	answer() Answers the channel.
void	bridge(String channelName, String options)
void	confbridge(String room, String profile)
void	continueAt(String context, String extension, String priority) Defines the point in the dialplan where the call will continue when the AGI script returns.
void	controlStreamFile(String file) Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind.
char	controlStreamFile(String file, String escapeDigits) Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind.
char	controlStreamFile(String file, String escapeDigits, int offset) Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind.
char	controlStreamFile(String file, String escapeDigits, int offset, String forwardDigit, String rewindDigit, String pauseDigit) Plays the given file allowing the user to control the streaming by using forwardDigit for forward, rewindDigit for rewind and pauseDigit for pause.
void	databaseDel(String family, String key) Deletes an entry in the Asterisk database for a given family and key.
void	databaseDelTree(String family) Deletes a whole family of entries in the Asterisk database.
void	databaseDelTree(String family, String keytree) Deletes all entries of a given family in the Asterisk database that have a key that starts with a given prefix.
String	databaseGet(String family, String key) Retrieves an entry in the Asterisk database for a given family and key.
void	databasePut(String family, String key, String value) Adds or updates an entry in the Asterisk database for a given family, key, and value.
void	dial(String target, int timeout, String options)
int	exec(String application) Executes the given command.
int	exec(String application, String... options) Executes the given command.
int	getChannelStatus() Returns the status of the channel.
String	getData(String file) Plays the given file and waits for the user to enter DTMF digits until he presses '#'.
String	getData(String file, long timeout) Plays the given file and waits for the user to enter DTMF digits until he presses '#' or the timeout occurs.
String	getData(String file, long timeout, int maxDigits) Plays the given file and waits for the user to enter DTMF digits until he presses '#' or the timeout occurs or the maximum number of digits has been entered.
String	getFullVariable(String expr) Evaluates a channel expression for the current channel.
String	getFullVariable(String expr, String channel) Evaluates a channel expression for the given channel.To extract the caller id of channel use getFullVariable("${CALLERID(name)}", "SIP/john-0085d860");.
AgiReply	getLastReply() Returns the reply received in response to the last command sent to Asterisk.
String	getName() Returns the name of the channel.
char	getOption(String file, String escapeDigits) Plays the given file, and waits for the user to press one of the given digits.
char	getOption(String file, String escapeDigits, long timeout) Plays the given file, and waits for the user to press one of the given digits.
String	getUniqueId() Returns the unqiue id of the channel.
String	getVariable(String name) Returns the value of the current channel or global variable.
void	gosub(String context, String extension, String priority) Calls a subroutine in the dialplan This method is available since Asterisk 1.6.
void	gosub(String context, String extension, String priority, String... arguments) Calls a subroutine in the dialplan
void	hangup() Hangs the channel up.
void	meetme(String room, String options)
void	playMusicOnHold() Plays music on hold from the default music on hold class.
void	playMusicOnHold(String musicOnHoldClass) Plays music on hold from the given music on hold class.
void	queue(String queue)
char	recordFile(String file, String format, String escapeDigits, int timeout) Record to a file until a given dtmf digit in the sequence is received.
char	recordFile(String file, String format, String escapeDigits, int timeout, int offset, boolean beep, int maxSilence) Record to a file until a given dtmf digit in the sequence is received.
void	sayAlpha(String text) Says the given character string.
char	sayAlpha(String text, String escapeDigits) Says the given character string, returning early if any of the given DTMF number are received on the channel.
void	sayDateTime(long time) Says the given time.
char	sayDateTime(long time, String escapeDigits) Says the given time and allows interruption by one of the given escape digits.
char	sayDateTime(long time, String escapeDigits, String format) Says the given time in the given format and allows interruption by one of the given escape digits.
char	sayDateTime(long time, String escapeDigits, String format, String timezone) Says the given time in the given format and timezone and allows interruption by one of the given escape digits.
void	sayDigits(String digits) Says the given digit string.
char	sayDigits(String digits, String escapeDigits) Says the given number, returning early if any of the given DTMF number are received on the channel.
void	sayNumber(String number) Says the given number.
char	sayNumber(String number, String escapeDigits) Says the given number, returning early if any of the given DTMF number are received on the channel.
void	sayPhonetic(String text) Says the given character string with phonetics.
char	sayPhonetic(String text, String escapeDigits) Says the given character string with phonetics, returning early if any of the given DTMF number are received on the channel.
void	sayTime(long time) Says the given time.
char	sayTime(long time, String escapeDigits) Says the given time, returning early if any of the given DTMF number are received on the channel.
AgiReply	sendCommand(AgiCommand command) Sends a command to asterisk and returns the corresponding reply.
void	setAutoHangup(int time) Cause the channel to automatically hangup at the given number of seconds in the future.
void	setCallerId(String callerId) Sets the caller id on the current channel.
void	setContext(String context) Sets the context for continuation upon exiting the application.
void	setExtension(String extension) Sets the extension for continuation upon exiting the application.
void	setPriority(String priority) Sets the priority or label for continuation upon exiting the application.
void	setVariable(String name, String value) Sets the value of the current channel or global variable to a new value.
void	speechActivateGrammar(String label) Activates the specified grammar.
void	speechCreate() Creates a speech object that uses the default speech engine.
void	speechCreate(String engine) Creates a speech object that uses the given speech engine.
void	speechDeactivateGrammar(String label) Deactivates the specified grammar.
void	speechDestroy() Destroys the current speech object.
void	speechLoadGrammar(String label, String path) Loads the specified grammar.
SpeechRecognitionResult	speechRecognize(String prompt, int timeout) Plays the given prompt while listening for speech and DTMF.
SpeechRecognitionResult	speechRecognize(String prompt, int timeout, int offset) Plays the given prompt while listening for speech and DTMF.
void	speechSet(String name, String value) Sets the speech engine setting indicated by name to the given value.
void	speechUnloadGrammar(String label) Unloads the specified grammar.
void	stopMusicOnHold() Stops playing music on hold.
void	streamFile(String file) Plays the given file.
char	streamFile(String file, String escapeDigits) Plays the given file and allows the user to escape by pressing one of the given digit.
char	streamFile(String file, String escapeDigits, int offset) Plays the given file starting at the specified offset and allows the user to escape by pressing one of the given digit.
void	verbose(String message, int level) Sends a message to the Asterisk console via the verbose message system.
char	waitForDigit(int timeout) Waits up to 'timeout' milliseconds to receive a DTMF digit.

Method Detail

getName

String getName()

Returns the name of the channel.

Returns:

the name of the channel.

getUniqueId

String getUniqueId()

Returns the unqiue id of the channel.

Returns:

the unqiue id of the channel.

getLastReply

AgiReply getLastReply()

Returns the reply received in response to the last command sent to Asterisk.

Returns:

the reply received in response to the last command sent to Asterisk or null if none has yet been received.

Since:

1.0.0

sendCommand

AgiReply sendCommand(AgiCommand command)
              throws AgiException

Sends a command to asterisk and returns the corresponding reply. The reply is also available through getLastReply().

Parameters:

command - the command to send.

Returns:

the reply of the asterisk server containing the return value.

Throws:

AgiException - if the command can't be sent to Asterisk (for example because the channel has been hung up)

answer

void answer()
     throws AgiException

Answers the channel.

Throws:

AgiException - agi exception

Since:

0.2

hangup

void hangup()
     throws AgiException

Hangs the channel up.

Throws:

AgiException - agi exception

Since:

0.2

setAutoHangup

void setAutoHangup(int time)
            throws AgiException

Cause the channel to automatically hangup at the given number of seconds in the future.

Parameters:

time - the number of seconds before this channel is automatically hung up.

0 disables the autohangup feature.

Throws:

AgiException - agi exception

Since:

0.2

setCallerId

void setCallerId(String callerId)
          throws AgiException

Sets the caller id on the current channel.

Parameters:

callerId - the raw caller id to set, for example "John Doe<1234>".

Throws:

AgiException - agi exception

Since:

0.2

playMusicOnHold

void playMusicOnHold()
              throws AgiException

Plays music on hold from the default music on hold class.

Throws:

AgiException - agi exception

Since:

0.2

playMusicOnHold

void playMusicOnHold(String musicOnHoldClass)
              throws AgiException

Plays music on hold from the given music on hold class.

Parameters:

musicOnHoldClass - the music on hold class to play music from as configures in Asterisk's musiconhold.conf.

Throws:

AgiException - agi exception

Since:

0.2

stopMusicOnHold

void stopMusicOnHold()
              throws AgiException

Stops playing music on hold.

Throws:

AgiException - agi exception

Since:

0.2

getChannelStatus

int getChannelStatus()
              throws AgiException

Returns the status of the channel.

Return values:

• 0 Channel is down and available
• 1 Channel is down, but reserved
• 2 Channel is off hook
• 3 Digits (or equivalent) have been dialed
• 4 Line is ringing
• 5 Remote end is ringing
• 6 Line is up
• 7 Line is busy

Returns:

the status of the channel.

Throws:

AgiException - agi exception

Since:

0.2

getData

String getData(String file)
        throws AgiException

Plays the given file and waits for the user to enter DTMF digits until he presses '#'. The user may interrupt the streaming by starting to enter digits.

Parameters:

file - the name of the file to play

Returns:

a String containing the DTMF the user entered

Throws:

AgiException - agi exception

Since:

0.2

getData

String getData(String file,
               long timeout)
        throws AgiException

Plays the given file and waits for the user to enter DTMF digits until he presses '#' or the timeout occurs. The user may interrupt the streaming by starting to enter digits.

Parameters:

file - the name of the file to play

timeout - the timeout in milliseconds to wait for user input.

0 means standard timeout value, -1 means "ludicrous time" (essentially never times out).

Returns:

a String containing the DTMF the user entered

Throws:

AgiException - agi exception

Since:

0.2

getData

String getData(String file,
               long timeout,
               int maxDigits)
        throws AgiException

Plays the given file and waits for the user to enter DTMF digits until he presses '#' or the timeout occurs or the maximum number of digits has been entered. The user may interrupt the streaming by starting to enter digits.

Parameters:

file - the name of the file to play

timeout - the timeout in milliseconds to wait for user input.

0 means standard timeout value, -1 means "ludicrous time" (essentially never times out).

maxDigits - the maximum number of digits the user is allowed to enter

Returns:

a String containing the DTMF the user entered

Throws:

AgiException - agi exception

Since:

0.2

getOption

char getOption(String file,
               String escapeDigits)
        throws AgiException

Plays the given file, and waits for the user to press one of the given digits. If none of the escape digits is pressed while streaming the file it waits for the default timeout of 5 seconds still waiting for the user to press a digit.

Parameters:

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

escapeDigits - contains the digits that the user is expected to press.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

getOption

char getOption(String file,
               String escapeDigits,
               long timeout)
        throws AgiException

Plays the given file, and waits for the user to press one of the given digits. If none of the escape digits is pressed while streaming the file it waits for the specified timeout still waiting for the user to press a digit.

Parameters:

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.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

confbridge

void confbridge(String room,
                String profile)
         throws AgiException

Throws:

AgiException

meetme

void meetme(String room,
            String options)
     throws AgiException

Throws:

AgiException

exec

int exec(String application)
  throws AgiException

Executes the given command.

Parameters:

application - the name of the application to execute, for example "Dial".

Returns:

the return code of the application of -2 if the application was not found.

Throws:

AgiException - agi exception

Since:

0.2

exec

int exec(String application,
         String... options)
  throws AgiException

Executes the given command.

Parameters:

application - the name of the application to execute, for example "Dial".

options - the parameters to pass to the application, for example "SIP/123".

Returns:

the return code of the application of -2 if the application was not found.

Throws:

AgiException - agi exception

Since:

0.2

setContext

void setContext(String context)
         throws AgiException

Sets the context for continuation upon exiting the application.

Parameters:

context - the context for continuation upon exiting the application.

Throws:

AgiException - agi exception

Since:

0.2

setExtension

void setExtension(String extension)
           throws AgiException

Sets the extension for continuation upon exiting the application.

Parameters:

extension - the extension for continuation upon exiting the application.

Throws:

AgiException - agi exception

Since:

0.2

setPriority

void setPriority(String priority)
          throws AgiException

Sets the priority or label for continuation upon exiting the application.

Parameters:

priority - the priority or label for continuation upon exiting the application.

Throws:

AgiException - agi exception

Since:

0.2

streamFile

void streamFile(String file)
         throws AgiException

Plays the given file.

Parameters:

file - name of the file to play.

Throws:

AgiException - agi exception

Since:

0.2

streamFile

char streamFile(String file,
                String escapeDigits)
         throws AgiException

Plays the given file and allows the user to escape by pressing one of the given digit.

Parameters:

file - name of the file to play.

escapeDigits - a String containing the DTMF digits that allow the user to escape.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

streamFile

char streamFile(String file,
                String escapeDigits,
                int offset)
         throws AgiException

Plays the given file starting at the specified offset and allows the user to escape by pressing one of the given digit.

Parameters:

file - name of the file to play.

escapeDigits - a String containing the DTMF digits that allow the user to escape.

offset - the offset samples to skip before streaming.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

1.0.0

sayDigits

void sayDigits(String digits)
        throws AgiException

Says the given digit string.

Parameters:

digits - the digit string to say.

Throws:

AgiException - agi exception

Since:

0.2

sayDigits

char sayDigits(String digits,
               String escapeDigits)
        throws AgiException

Says the given number, returning early if any of the given DTMF number are received on the channel.

Parameters:

digits - the digit string to say.

escapeDigits - a String containing the DTMF digits that allow the user to escape.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

sayNumber

void sayNumber(String number)
        throws AgiException

Says the given number.

Parameters:

number - the number to say.

Throws:

AgiException - agi exception

Since:

0.2

sayNumber

char sayNumber(String number,
               String escapeDigits)
        throws AgiException

Says the given number, returning early if any of the given DTMF number are received on the channel.

Parameters:

number - the number to say.

escapeDigits - a String containing the DTMF digits that allow the user to escape.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

sayPhonetic

void sayPhonetic(String text)
          throws AgiException

Says the given character string with phonetics.

Parameters:

text - the text to say.

Throws:

AgiException - agi exception

Since:

0.2

sayPhonetic

char sayPhonetic(String text,
                 String escapeDigits)
          throws AgiException

Says the given character string with phonetics, returning early if any of the given DTMF number are received on the channel.

Parameters:

text - the text to say.

escapeDigits - a String containing the DTMF digits that allow the user to escape.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

sayAlpha

void sayAlpha(String text)
       throws AgiException

Says the given character string.

Parameters:

text - the text to say.

Throws:

AgiException - agi exception

Since:

0.2

sayAlpha

char sayAlpha(String text,
              String escapeDigits)
       throws AgiException

Says the given character string, returning early if any of the given DTMF number are received on the channel.

Parameters:

text - the text to say.

escapeDigits - a String containing the DTMF digits that allow the user to escape.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

sayTime

void sayTime(long time)
      throws AgiException

Says the given time.

Parameters:

time - the time to say in seconds since 00:00:00 on January 1, 1970.

Throws:

AgiException - agi exception

Since:

0.2

sayTime

char sayTime(long time,
             String escapeDigits)
      throws AgiException

Says the given time, returning early if any of the given DTMF number are received on the channel.

Parameters:

time - the time to say in seconds since 00:00:00 on January 1, 1970.

escapeDigits - a String containing the DTMF digits that allow the user to escape.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

getVariable

String getVariable(String name)
            throws AgiException

Returns the value of the current channel or global variable.
Supports functions and builtin variables. To retrieve the caller id you can use getVariable("CALLERID(name)");
Does not support expression parsing, use getFullVariable(String) in those cases.

Parameters:

name - the name of the variable (or function call) to retrieve.

Returns:

the value of the given variable or null if not set.

Throws:

AgiException - agi exception

Since:

0.2

setVariable

void setVariable(String name,
                 String value)
          throws AgiException

Sets the value of the current channel or global variable to a new value.
Supports functions and builtin variables. To set the caller id you can use setVariable("CALLERID(name)", "John Doe");

Parameters:

name - the name of the variable (or function call) to set.

value - the new value to set.

Throws:

AgiException - agi exception

Since:

0.2

waitForDigit

char waitForDigit(int timeout)
           throws AgiException

Waits up to 'timeout' milliseconds to receive a DTMF digit.

Parameters:

timeout - timeout the milliseconds to wait for the channel to receive a DTMF digit, -1 will wait forever.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

getFullVariable

String getFullVariable(String expr)
                throws AgiException

Evaluates a channel expression for the current channel. To extract the caller id use getFullVariable("${CALLERID(name)}");.

Available since Asterisk 1.2.

Parameters:

expr - the expression to evaluate.

Returns:

the value of the given expression or null if not set.

Throws:

AgiException - agi exception

Since:

0.2

See Also:

getVariable(String)

getFullVariable

String getFullVariable(String expr,
                       String channel)
                throws AgiException

Evaluates a channel expression for the given channel.To extract the caller id of channel use getFullVariable("${CALLERID(name)}", "SIP/john-0085d860");.

Available since Asterisk 1.2.

Parameters:

expr - the the expression to evaluate.

channel - the name of the channel.

Returns:

the value of the given expression or null if not set.

Throws:

AgiException - agi exception

Since:

0.2

sayDateTime

void sayDateTime(long time)
          throws AgiException

Says the given time.

Available since Asterisk 1.2.

Parameters:

time - the time to say in seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC)

Throws:

AgiException - agi exception

Since:

0.2

sayDateTime

char sayDateTime(long time,
                 String escapeDigits)
          throws AgiException

Says the given time and allows interruption by one of the given escape digits.

Available since Asterisk 1.2.

Parameters:

time - the time to say in seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC)

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

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

sayDateTime

char sayDateTime(long time,
                 String escapeDigits,
                 String format)
          throws AgiException

Says the given time in the given format and allows interruption by one of the given escape digits.

Available since Asterisk 1.2.

Parameters:

time - the time to say in seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC)

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

format - the format the time should be said in

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

sayDateTime

char sayDateTime(long time,
                 String escapeDigits,
                 String format,
                 String timezone)
          throws AgiException

Says the given time in the given format and timezone and allows interruption by one of the given escape digits.

Available since Asterisk 1.2.

Parameters:

time - the time to say in seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC)

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

format - the format the time should be said in

timezone - the timezone to use when saying the time, for example "UTC" or "Europe/Berlin".

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.2

databaseGet

String databaseGet(String family,
                   String key)
            throws AgiException

Retrieves an entry in the Asterisk database for a given family and key.

Parameters:

family - the family of the entry to retrieve.

key - the key of the entry to retrieve.

Returns:

the value of the given family and key or null if there is no such value.

Throws:

AgiException - agi exception

Since:

0.3

databasePut

void databasePut(String family,
                 String key,
                 String value)
          throws AgiException

Adds or updates an entry in the Asterisk database for a given family, key, and value.

Parameters:

family - the family of the entry to add or update.

key - the key of the entry to add or update.

value - the new value of the entry.

Throws:

AgiException - agi exception

Since:

0.3

databaseDel

void databaseDel(String family,
                 String key)
          throws AgiException

Deletes an entry in the Asterisk database for a given family and key.

Parameters:

family - the family of the entry to delete.

key - the key of the entry to delete.

Throws:

AgiException - agi exception

Since:

0.3

databaseDelTree

void databaseDelTree(String family)
              throws AgiException

Deletes a whole family of entries in the Asterisk database.

Parameters:

family - the family to delete.

Throws:

AgiException - agi exception

Since:

0.3

databaseDelTree

void databaseDelTree(String family,
                     String keytree)
              throws AgiException

Deletes all entries of a given family in the Asterisk database that have a key that starts with a given prefix.

Parameters:

family - the family of the entries to delete.

keytree - the prefix of the keys of the entries to delete.

Throws:

AgiException - agi exception

Since:

0.3

verbose

void verbose(String message,
             int level)
      throws AgiException

Sends a message to the Asterisk console via the verbose message system.

Parameters:

message - the message to send.

level - the verbosity level to use. Must be in [1..4].

Throws:

AgiException - agi exception

Since:

0.3

recordFile

char recordFile(String file,
                String format,
                String escapeDigits,
                int timeout)
         throws AgiException

Record to a file until a given dtmf digit in the sequence is received.

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.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.3

recordFile

char recordFile(String file,
                String format,
                String escapeDigits,
                int timeout,
                int offset,
                boolean beep,
                int maxSilence)
         throws AgiException

Record to a file until a given dtmf digit in the sequence is received.

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.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.3

controlStreamFile

void controlStreamFile(String file)
                throws AgiException

Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind.

Parameters:

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

Throws:

AgiException - agi exception

Since:

0.3

controlStreamFile

char controlStreamFile(String file,
                       String escapeDigits)
                throws AgiException

Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind. Pressing one of the escape digits stops streaming.

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.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.3

controlStreamFile

char controlStreamFile(String file,
                       String escapeDigits,
                       int offset)
                throws AgiException

Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind. Pressing one of the escape digits stops streaming. The file is played starting at the indicated offset.

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.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.3

controlStreamFile

char controlStreamFile(String file,
                       String escapeDigits,
                       int offset,
                       String forwardDigit,
                       String rewindDigit,
                       String pauseDigit)
                throws AgiException

Plays the given file allowing the user to control the streaming by using forwardDigit for forward, rewindDigit for rewind and pauseDigit for pause. Pressing one of the escape digits stops streaming. The file is played starting at the indicated offset, use 0 to start at the beginning.

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, use 0 to start at the beginning.

forwardDigit - the digit for fast forward.

rewindDigit - the digit for rewind.

pauseDigit - the digit for pause and unpause.

Returns:

the DTMF digit pressed or 0x0 if none was pressed.

Throws:

AgiException - agi exception

Since:

0.3

speechCreate

void speechCreate()
           throws AgiException

Creates a speech object that uses the default speech engine. The speech object is used by the other speech methods and must be created before they are called.

Throws:

AgiSpeechException - if the speech object cannot be created.

AgiException - agi exception

Since:

1.0.0

speechCreate

void speechCreate(String engine)
           throws AgiException

Creates a speech object that uses the given speech engine. The speech object is used by the other speech methods and must be created before they are called.

Parameters:

engine - the name of the speech engine. For example "lumenvox".

Throws:

AgiException - agi exception

Since:

1.0.0

speechSet

void speechSet(String name,
               String value)
        throws AgiException

Sets the speech engine setting indicated by name to the given value.

Parameters:

name - the name of the setting to set.

value - the value to set.

Throws:

AgiException - agi exception

Since:

1.0.0

speechDestroy

void speechDestroy()
            throws AgiException

Destroys the current speech object.

Throws:

AgiException - agi exception

Since:

1.0.0

speechLoadGrammar

void speechLoadGrammar(String label,
                       String path)
                throws AgiException

Loads the specified grammar. The grammer is then available for calls to speechActivateGrammar(String) under the given name. Eplicitly loading a grammer is only required if the grammer has not been defined in the speech engine configuration, e.g. the [grammars] section of lumenvox.conf.

Parameters:

label - the name of the grammar, used for subsequent calls to speechActivateGrammar(String), speechDeactivateGrammar(String) and speechUnloadGrammar(String).

path - the path to the grammar to load.

Throws:

AgiException - agi exception

Since:

1.0.0

speechUnloadGrammar

void speechUnloadGrammar(String label)
                  throws AgiException

Unloads the specified grammar.

Parameters:

label - the name of the grammar to unload.

Throws:

AgiException - agi exception

Since:

1.0.0

speechActivateGrammar

void speechActivateGrammar(String label)
                    throws AgiException

Activates the specified grammar.

Parameters:

label - the name of the grammar to activate.

Throws:

AgiException - agi exception

Since:

1.0.0

speechDeactivateGrammar

void speechDeactivateGrammar(String label)
                      throws AgiException

Deactivates the specified grammar.

Parameters:

label - the name to the grammar to deactivate.

Throws:

AgiException - agi exception

Since:

1.0.0

speechRecognize

SpeechRecognitionResult speechRecognize(String prompt,
                                        int timeout)
                                 throws AgiException

Plays the given prompt while listening for speech and DTMF.

Parameters:

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

timeout - the timeout in milliseconds to wait for user input.

0 means standard timeout value, -1 means "ludicrous time" (essentially never times out).

Returns:

the recognition result

Throws:

AgiException - agi exception

Since:

1.0.0

speechRecognize

SpeechRecognitionResult speechRecognize(String prompt,
                                        int timeout,
                                        int offset)
                                 throws AgiException,
                                        AgiSpeechException

Plays the given prompt while listening for speech and DTMF.

Parameters:

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

timeout - the timeout in milliseconds to wait for user input.

0 means standard timeout value, -1 means "ludicrous time" (essentially never times out).

offset - the offset samples to skip before streaming, use 0 to start at the beginning.

Returns:

the recognition result

Throws:

AgiException - agi exception

AgiSpeechException - speech exception

Since:

1.0.0

continueAt

void continueAt(String context,
                String extension,
                String priority)
         throws AgiException

Defines the point in the dialplan where the call will continue when the AGI script returns.

This is a shortcut for calling setContext(String), setExtension(String) and setPriority(String) in series.

Parameters:

context - the context for continuation upon exiting the application.

extension - the extension for continuation upon exiting the application.

priority - the priority or label for continuation upon exiting the application.

Throws:

AgiException - agi exception

Since:

1.0.0

gosub

void gosub(String context,
           String extension,
           String priority)
    throws AgiException

Calls a subroutine in the dialplan
This method is available since Asterisk 1.6.

Parameters:

context - the context of the called subroutine.

extension - the extension in the called context.

priority - the priority of the called extension.

Throws:

AgiException - agi exception

Since:

1.0.0

gosub

void gosub(String context,
           String extension,
           String priority,
           String... arguments)
    throws AgiException

Calls a subroutine in the dialplan

This method is available since Asterisk 1.6.

Parameters:

context - the context of the called subroutine.

extension - the extension in the called context.

priority - the priority of the called extension.

arguments - optional arguments to be passed to the subroutine. They should be separated by comma. They will accessible in the form of ${ARG1}, ${ARG2}, etc in the subroutine body.

Throws:

AgiException - agi exception

Since:

1.0.0

dial

void dial(String target,
          int timeout,
          String options)
   throws AgiException

Throws:

AgiException

bridge

void bridge(String channelName,
            String options)
     throws AgiException

Throws:

AgiException

queue

void queue(String queue)
    throws AgiException

Throws:

AgiException