diff options
author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-01-11 05:23:19 +0000 |
---|---|---|
committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-01-11 05:23:19 +0000 |
commit | 07ec2feb5145839eb411485f442e657dc8acdb12 (patch) | |
tree | 495a1f82b9c522d040af9fd20b9042b4a84523c0 /include/asterisk/app.h | |
parent | 1d62e35521e1c96ce56214e6d84acc862e318445 (diff) |
add doxygen documentation and fix various issues with ast_dtmf_stream
(discussed in issue #6087)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@7969 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/app.h')
-rw-r--r-- | include/asterisk/app.h | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/include/asterisk/app.h b/include/asterisk/app.h index b40c2ce4c..4cae463e8 100644 --- a/include/asterisk/app.h +++ b/include/asterisk/app.h @@ -118,8 +118,18 @@ int ast_app_messagecount(const char *mailbox, int *newmsgs, int *oldmsgs); */ extern int ast_safe_system(const char *s); -/*! Send DTMF to chan (optionally entertain peer) */ -int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, char *digits, int between); +/*! + \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. +*/ +int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between); /*! Stream a filename (or file descriptor) as a generator. */ int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride); |