From ad08eeaabf314b80760f137633ceadfb91947033 Mon Sep 17 00:00:00 2001 From: "Eliel C. Sardanons" Date: Fri, 22 May 2009 19:11:44 +0000 Subject: Moved static documentation to the AstXML form. Moved AGI commands static documentation to XML docs ('say alpha', 'say digits', 'say number', 'say phonetic', 'say date' and 'say time'). git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@196344 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- res/res_agi.c | 153 +++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 103 insertions(+), 50 deletions(-) (limited to 'res/res_agi.c') diff --git a/res/res_agi.c b/res/res_agi.c index fea57800d..adf42651c 100644 --- a/res/res_agi.c +++ b/res/res_agi.c @@ -346,6 +346,103 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") value must be preceeded by s= and is also optional. + + + Says a given character string. + + + + + + + Say a given character string, returning early if any of the given DTMF digits + are received on the channel. 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/hangup. + + + + + Says a given digit string. + + + + + + + Say a given digit string, returning early if any of the given DTMF digits + are received on the channel. 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/hangup. + + + + + Says a given number. + + + + + + + + Say a given number, returning early if any of the given DTMF digits + are received on the channel. 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/hangup. + + + + + Says a given character string with phonetics. + + + + + + + Say a given character string with phonetics, returning early if any of the + given DTMF digits are received on the channel. Returns 0 if + playback completes without a digit pressed, the ASCII numerical value of the digit + if one was pressed, or -1 on error/hangup. + + + + + Says a given date. + + + + Is number of seconds elapsed since 00:00:00 on January 1, 1970. + Coordinated Universal Time (UTC). + + + + + Say a given date, returning early if any of the given DTMF digits are + received on the channel. 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/hangup. + + + + + Says a given time. + + + + Is number of seconds elapsed since 00:00:00 on January 1, 1970. + Coordinated Universal Time (UTC). + + + + + Say a given time, returning early if any of the given DTMF digits are + received on the channel. 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/hangup. + + Enable/Disable Music on hold generator @@ -2416,43 +2513,6 @@ static const char usage_controlstreamfile[] = " extension must not be included in the filename.\n\n" " Note: ffchar and rewchar default to * and # respectively.\n"; -static const char usage_saynumber[] = -" Usage: SAY NUMBER [gender]\n" -" Say a given number, returning early if any of the given DTMF digits\n" -" are received on the channel. Returns 0 if playback completes without a digit\n" -" being pressed, or the ASCII numerical value of the digit if one was pressed or\n" -" -1 on error/hangup.\n"; - -static const char usage_saydigits[] = -" Usage: SAY DIGITS \n" -" Say a given digit string, returning early if any of the given DTMF digits\n" -" are received on the channel. Returns 0 if playback completes without a digit\n" -" being pressed, or the ASCII numerical value of the digit if one was pressed or\n" -" -1 on error/hangup.\n"; - -static const char usage_sayalpha[] = -" Usage: SAY ALPHA \n" -" Say a given character string, returning early if any of the given DTMF digits\n" -" are received on the channel. Returns 0 if playback completes without a digit\n" -" being pressed, or the ASCII numerical value of the digit if one was pressed or\n" -" -1 on error/hangup.\n"; - -static const char usage_saydate[] = -" Usage: SAY DATE \n" -" Say a given date, returning early if any of the given DTMF digits are\n" -" received on the channel. is number of seconds elapsed since 00:00:00\n" -" on January 1, 1970, Coordinated Universal Time (UTC). Returns 0 if playback\n" -" completes without a digit being pressed, or the ASCII numerical value of the\n" -" digit if one was pressed or -1 on error/hangup.\n"; - -static const char usage_saytime[] = -" Usage: SAY TIME