aboutsummaryrefslogtreecommitdiffstats
path: root/include/asterisk/app.h
diff options
context:
space:
mode:
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2006-07-30 15:02:34 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2006-07-30 15:02:34 +0000
commit3555ba6c4197c6becc6b83ceb65158e946fee494 (patch)
treefd116aebb9c2834d27f70ab98fa05dfa2067b7b3 /include/asterisk/app.h
parentfd2169cf668588f0396ea4877012f3ea5eccac5e (diff)
Add details about flash and wait to doxygen about DTMF.
Reformat the lines to break at column 80. git-svn-id: http://svn.digium.com/svn/asterisk/trunk@38521 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/app.h')
-rw-r--r--include/asterisk/app.h17
1 files changed, 11 insertions, 6 deletions
diff --git a/include/asterisk/app.h b/include/asterisk/app.h
index 4244c79b5..88587acfa 100644
--- a/include/asterisk/app.h
+++ b/include/asterisk/app.h
@@ -144,12 +144,17 @@ void ast_unreplace_sigchld(void);
\brief Send DTMF to a channel
\param chan The channel that will receive the DTMF frames
- \param peer (optional) Peer channel that will be autoserviced while the primary
- channel is receiving DTMF
- \param digits This is a string of characters representing the DTMF digits to be sent
- to the channel. Valid characters are "0123456789*#abcdABCD".
- \param between This is the number of milliseconds to wait in between each DTMF digit.
- If zero milliseconds is specified, then the default value of 100 will be used.
+ \param peer (optional) Peer channel that will be autoserviced while the
+ primary channel is receiving DTMF
+ \param digits This is a string of characters representing the DTMF digits
+ to be sent to the channel. Valid characters are
+ "0123456789*#abcdABCD". Note: You can pass arguments 'f' or
+ 'F', if you want to Flash the channel (if supported by the
+ channel), or 'w' to add a 500 millisecond pause to the DTMF
+ sequence.
+ \param between This is the number of milliseconds to wait in between each
+ DTMF digit. If zero milliseconds is specified, then the
+ default value of 100 will be used.
*/
int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between);