Version 0.1.10 from FTP
[asterisk/asterisk.git] / include / asterisk / say.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Say numbers and dates (maybe words one day too)
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_SAY_H
15 #define _ASTERISK_SAY_H
16
17 #include <asterisk/channel.h>
18 #include <asterisk/file.h>
19
20 #if defined(__cplusplus) || defined(c_plusplus)
21 extern "C" {
22 #endif
23
24 //! says a number
25 /*! 
26  * \param chan channel to say them number on
27  * \param num number to say on the channel
28  * \param ints which dtmf to interrupt on
29  * \param lang language to speak the number
30  * Vocally says a number on a given channel
31  * Returns 0 on success, DTMF digit on interrupt, -1 on failure
32  */
33 int ast_say_number(struct ast_channel *chan, int num, char *ints, char *lang);
34
35 //! says digits
36 /*!
37  * \param chan channel to act upon
38  * \param num number to speak
39  * \param ints which dtmf to interrupt on
40  * \param lang language to speak
41  * Vocally says digits of a given number
42  * Returns 0 on success, dtmf if interrupted, -1 on failure
43  */
44 int ast_say_digits(struct ast_channel *chan, int num, char *ints, char *lang);
45
46 //! says digits of a string
47 /*! 
48  * \param chan channel to act upon
49  * \param num string to speak
50  * \param ints which dtmf to interrupt on
51  * \param lang language to speak in
52  * Vocally says the digits of a given string
53  * Returns 0 on success, dtmf if interrupted, -1 on failure
54  */
55 int ast_say_digit_str(struct ast_channel *chan, char *num, char *ints, char *lang);
56
57 #if defined(__cplusplus) || defined(c_plusplus)
58 }
59 #endif
60
61 #endif