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

say.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- A telephony toolkit for Linux.
00003  *
00004  * Say numbers and dates (maybe words one day too)
00005  * 
00006  * Copyright (C) 1999, Mark Spencer
00007  *
00008  * Mark Spencer <markster@linux-support.net>
00009  *
00010  * This program is free software, distributed under the terms of
00011  * the GNU General Public License
00012  */
00013 
00014 #ifndef _ASTERISK_SAY_H
00015 #define _ASTERISK_SAY_H
00016 
00017 #include <asterisk/channel.h>
00018 #include <asterisk/file.h>
00019 
00020 #include <time.h>
00021 
00022 #if defined(__cplusplus) || defined(c_plusplus)
00023 extern "C" {
00024 #endif
00025 
00026 //! says a number
00027 /*! 
00028  * \param chan channel to say them number on
00029  * \param num number to say on the channel
00030  * \param ints which dtmf to interrupt on
00031  * \param lang language to speak the number
00032  * \param options set to 'f' for female, 'm' for masculine (used in portuguese)
00033  * Vocally says a number on a given channel
00034  * Returns 0 on success, DTMF digit on interrupt, -1 on failure
00035  */
00036 int ast_say_number(struct ast_channel *chan, int num, char *ints, char *lang, char *options);
00037 
00038 /* Same as above with audiofd for received audio and returns 1 on ctrlfd being readable */
00039 int ast_say_number_full(struct ast_channel *chan, int num, char *ints, char *lang, char *options, int audiofd, int ctrlfd);
00040 
00041 //! says digits
00042 /*!
00043  * \param chan channel to act upon
00044  * \param num number to speak
00045  * \param ints which dtmf to interrupt on
00046  * \param lang language to speak
00047  * Vocally says digits of a given number
00048  * Returns 0 on success, dtmf if interrupted, -1 on failure
00049  */
00050 int ast_say_digits(struct ast_channel *chan, int num, char *ints, char *lang);
00051 int ast_say_digits_full(struct ast_channel *chan, int num, char *ints, char *lang, int audiofd, int ctrlfd);
00052 
00053 //! says digits of a string
00054 /*! 
00055  * \param chan channel to act upon
00056  * \param num string to speak
00057  * \param ints which dtmf to interrupt on
00058  * \param lang language to speak in
00059  * Vocally says the digits of a given string
00060  * Returns 0 on success, dtmf if interrupted, -1 on failure
00061  */
00062 int ast_say_digit_str(struct ast_channel *chan, char *num, char *ints, char *lang);
00063 int ast_say_digit_str_full(struct ast_channel *chan, char *num, char *ints, char *lang, int audiofd, int ctrlfd);
00064 int ast_say_character_str(struct ast_channel *chan, char *num, char *ints, char *lang);
00065 int ast_say_character_str_full(struct ast_channel *chan, char *num, char *ints, char *lang, int audiofd, int ctrlfd);
00066 int ast_say_phonetic_str(struct ast_channel *chan, char *num, char *ints, char *lang);
00067 int ast_say_phonetic_str_full(struct ast_channel *chan, char *num, char *ints, char *lang, int audiofd, int ctrlfd);
00068 
00069 int ast_say_datetime(struct ast_channel *chan, time_t t, char *ints, char *lang);
00070 
00071 int ast_say_time(struct ast_channel *chan, time_t t, char *ints, char *lang);
00072 
00073 int ast_say_date(struct ast_channel *chan, time_t t, char *ints, char *lang);
00074 
00075 int ast_say_datetime_from_now(struct ast_channel *chan, time_t t, char *ints, char *lang);
00076 
00077 int ast_say_date_with_format(struct ast_channel *chan, time_t t, char *ints, char *lang, char *format, char *timezone);
00078 
00079 #if defined(__cplusplus) || defined(c_plusplus)
00080 }
00081 #endif
00082 
00083 #endif

Generated on Thu Nov 29 22:50:24 2007 for Asterisk by  doxygen 1.4.2