Version 0.1.10 from FTP

[asterisk/asterisk.git] / include / asterisk / app.h

diff --git a/include/asterisk/app.h b/include/asterisk/app.h
index ecb1ab1..bf9c5b0 100755 (executable)
--- a/include/asterisk/app.h
+++ b/include/asterisk/app.h
@@ -18,6 +18,19 @@
 #if defined(__cplusplus) || defined(c_plusplus)
 extern "C" {
 #endif
+//! Plays a stream and gets DTMF data from a channel
+/*!
+ * \param c Which channel one is interacting with
+ * \param prompt File to pass to ast_streamfile (the one that you wish to play)
+ * \param s The location where the DTMF data will be stored
+ * \param maxlen Max Length of the data
+ * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
+ *
+ *  This function was designed for application programmers for situations where they need 
+ *  to play a message and then get some DTMF data in response to the message.  If a digit 
+ *  is pressed during playback, it will immediately break out of the message and continue
+ *  execution of your code.
+ */
 extern int ast_app_getdata(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout);
 
 #if defined(__cplusplus) || defined(c_plusplus)