Main Page | Alphabetical List | Data Structures | File List | Data Fields | Globals

app.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- A telephony toolkit for Linux.
00003  *
00004  * Application convenience functions, designed to give consistent
00005  * look and feel to asterisk apps.
00006  * 
00007  * Copyright (C) 1999, Mark Spencer
00008  *
00009  * Mark Spencer <markster@linux-support.net>
00010  *
00011  * This program is free software, distributed under the terms of
00012  * the GNU General Public License
00013  */
00014 
00015 #ifndef _ASTERISK_APP_H
00016 #define _ASTERISK_APP_H
00017 
00018 #if defined(__cplusplus) || defined(c_plusplus)
00019 extern "C" {
00020 #endif
00021 //! Plays a stream and gets DTMF data from a channel
00022 /*!
00023  * \param c Which channel one is interacting with
00024  * \param prompt File to pass to ast_streamfile (the one that you wish to play)
00025  * \param s The location where the DTMF data will be stored
00026  * \param maxlen Max Length of the data
00027  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
00028  *
00029  *  This function was designed for application programmers for situations where they need 
00030  *  to play a message and then get some DTMF data in response to the message.  If a digit 
00031  *  is pressed during playback, it will immediately break out of the message and continue
00032  *  execution of your code.
00033  */
00034 extern int ast_app_getdata(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout);
00035 
00036 /* Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
00037 extern int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
00038 
00039 //! Record voice (after playing prompt if specified), waiting for silence (in ms) up to a given timeout (in s) or '#'
00040 int ast_app_getvoice(struct ast_channel *c, char *dest, char *dstfmt, char *prompt, int silence, int maxsec);
00041 
00042 //! Determine if a given mailbox has any voicemail
00043 extern int ast_app_has_voicemail(const char *mailbox);
00044 
00045 //! Determine number of new/old messages in a mailbox
00046 extern int ast_app_messagecount(const char *mailbox, int *newmsgs, int *oldmsgs);
00047 
00048 #if defined(__cplusplus) || defined(c_plusplus)
00049 }
00050 #endif
00051 
00052 #endif

Generated on Fri Oct 31 07:05:04 2003 for Asterisk by doxygen 1.3.4