From 3eb7fbba72482b3019a7493c68e533e67d9d8235 Mon Sep 17 00:00:00 2001 From: Sean Bright Date: Tue, 23 May 2017 14:33:16 -0400 Subject: [PATCH] res_agi: Clarify 'RECORD FILE' documentation Documented the 'beep' option in both the parameters list and the command description. ASTERISK-23839 #close Change-Id: I4970395c922dbdce3f7cf0f56d5b065ec9aa53ea --- res/res_agi.c | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/res/res_agi.c b/res/res_agi.c index cd0d621eb1..22c480a62a 100644 --- a/res/res_agi.c +++ b/res/res_agi.c @@ -451,13 +451,34 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Records to a given file. - - - - - - - + + The destination filename of the recorded audio. + + + The audio format in which to save the resulting file. + + + The DTMF digits that will terminate the recording process. + + + The maximum recording time in milliseconds. Set to -1 for no + limit. + + + Causes the recording to first seek to the specified offset before + recording begins. + + + Causes Asterisk to play a beep as recording begins. This argument + can take any value. + + + The number of seconds of silence that are permitted before the + recording is terminated, regardless of the + escape_digits or timeout + arguments. If specified, this parameter must be preceded by + s=. + Record to a file until a given dtmf digit in the sequence is received. @@ -465,7 +486,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") 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 + to the offset without exceeding the end of the + file. beep can take any value, and causes Asterisk + to play a beep to the channel that is about to be recorded. 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 preceded by s= and is also optional.