Main Page | Alphabetical List | Data Structures | Directories | 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-2004, Digium, Inc.
00008  *
00009  * Mark Spencer <markster@digium.com>
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 //! Safely spawn an external program while closingn file descriptors
00049 extern int ast_safe_system(const char *s);
00050 
00051 //! Send DTMF to chan (optionally entertain peer)  
00052 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, char *digits, int between);
00053 
00054 //! Stream a filename (or file descriptor) as a generator.
00055 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
00056 
00057 //! Stream a file with fast forward, pause, reverse.
00058 int ast_control_streamfile(struct ast_channel *chan, char *file, char *fwd, char *rev, char *stop, char *pause, int skipms);
00059 
00060 //! Play a stream and wait for a digit, returning the digit that was pressed
00061 int ast_play_and_wait(struct ast_channel *chan, char *fn);
00062 
00063 //! Record a file for a max amount of time (in seconds), in a given list of formats separated by '|', outputting the duration of the recording, and with a maximum
00064 //  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults.
00065 //  calls ast_unlock_path() on 'path' if passed
00066 int ast_play_and_record(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int silencethreshold, int maxsilence_ms, const char *path);
00067 
00068 //! Record a message and prepend the message to the given record file after playing the optional playfile (or a beep), storing the duration in 'duration' and with a maximum
00069 //  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults.
00070 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int beep, int silencethreshold, int maxsilence_ms);
00071 
00072 /* Lock a path */
00073 int ast_lock_path(const char *path);
00074 
00075 /* Unlock a path */
00076 int ast_unlock_path(const char *path);
00077 
00078 #if defined(__cplusplus) || defined(c_plusplus)
00079 }
00080 #endif
00081 
00082 #endif

Generated on Sat Nov 25 19:09:28 2006 for Asterisk by  doxygen 1.4.2