diff --git a/res/res_agi.c b/res/res_agi.c index 22002557a5..93dc6c664c 100644 --- a/res/res_agi.c +++ b/res/res_agi.c @@ -288,6 +288,64 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Does nothing. + + + Receives one character from channels supporting it. + + + + The maximum time to wait for input in milliseconds, or 0 + for infinite. Most channels + + + + Receives a character of text on a channel. Most channels do not support + the reception of text. Returns the decimal value of the character + if one is received, or 0 if the channel does not support + text reception. Returns -1 only on error/hangup. + + + + + Receives text from channels supporting it. + + + + The timeout to be the maximum time to wait for input in + milliseconds, or 0 for infinite. + + + + Receives a string of text on a channel. Most channels + do not support the reception of text. Returns -1 for failure + or 1 for success, and the string in parenthesis. + + + + + Records to a given file. + + + + + + + + + + + + Record to a file until a given dtmf digit in the sequence is received. + Returns -1 on hangup or error. The format will specify what kind of file + will be recorded. The timeout is the maximum record time in + milliseconds, or -1 for no timeout. + offset samples is optional, and, if provided, will seek + to the offset without exceeding the end of the file. silence is + the number of seconds of silence allowed before the function returns despite the + lack of dtmf digits or reaching timeout. silence + value must be preceeded by s= and is also optional. + + Enable/Disable Music on hold generator @@ -2324,20 +2382,6 @@ static char usage_sendtext[] = " consisting of greater than one word should be placed in quotes since the\n" " command only accepts a single argument.\n"; -static char usage_recvchar[] = -" Usage: RECEIVE CHAR \n" -" Receives a character of text on a channel. Specify timeout to be the\n" -" maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n" -" do not support the reception of text. Returns the decimal value of the character\n" -" if one is received, or 0 if the channel does not support text reception. Returns\n" -" -1 only on error/hangup.\n"; - -static char usage_recvtext[] = -" Usage: RECEIVE TEXT \n" -" Receives a string of text on a channel. Specify timeout to be the\n" -" maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n" -" do not support the reception of text. Returns -1 for failure or 1 for success, and the string in parentheses.\n"; - static char usage_tddmode[] = " Usage: TDD MODE \n" " Enable/Disable TDD transmission/reception on a channel. Returns 1 if\n" @@ -2438,18 +2482,6 @@ static char usage_setpriority[] = " Changes the priority for continuation upon exiting the application.\n" " The priority must be a valid priority or label.\n"; -static char usage_recordfile[] = -" Usage: RECORD FILE \\\n" -" [offset samples] [BEEP] [s=silence]\n" -" Record to a file until a given dtmf digit in the sequence is received\n" -" Returns -1 on hangup or error. The format will specify what kind of file\n" -" will be recorded. The timeout is the maximum record time in milliseconds, or\n" -" -1 for no timeout. \"Offset samples\" is optional, and, if provided, will seek\n" -" to the offset without exceeding the end of the file. \"silence\" is the number\n" -" of seconds of silence allowed before the function returns despite the\n" -" lack of dtmf digits or reaching timeout. Silence value must be\n" -" preceeded by \"s=\" and is also optional.\n"; - static char usage_autohangup[] = " Usage: SET AUTOHANGUP