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 #include <time.h>
  21
  22 #if defined(__cplusplus) || defined(c_plusplus)
  23 extern "C" {
  24 #endif
  25
  26 //! says a number
  27 /*!
  28  * \param chan channel to say them number on
  29  * \param num number to say on the channel
  30  * \param ints which dtmf to interrupt on
  31  * \param lang language to speak the number
  32  * Vocally says a number on a given channel
  33  * Returns 0 on success, DTMF digit on interrupt, -1 on failure
  34  */
  35 int ast_say_number(struct ast_channel *chan, int num, char *ints, char *lang);
  36
  37 //! says digits
  38 /*!
  39  * \param chan channel to act upon
  40  * \param num number to speak
  41  * \param ints which dtmf to interrupt on
  42  * \param lang language to speak
  43  * Vocally says digits of a given number
  44  * Returns 0 on success, dtmf if interrupted, -1 on failure
  45  */
  46 int ast_say_digits(struct ast_channel *chan, int num, char *ints, char *lang);
  47
  48 //! says digits of a string
  49 /*!
  50  * \param chan channel to act upon
  51  * \param num string to speak
  52  * \param ints which dtmf to interrupt on
  53  * \param lang language to speak in
  54  * Vocally says the digits of a given string
  55  * Returns 0 on success, dtmf if interrupted, -1 on failure
  56  */
  57 int ast_say_digit_str(struct ast_channel *chan, char *num, char *ints, char *lang);
  58
  59 int ast_say_datetime(struct ast_channel *chan, time_t t, char *ints, char *lang);
  60
  61 int ast_say_time(struct ast_channel *chan, time_t t, char *ints, char *lang);
  62
  63 int ast_say_date(struct ast_channel *chan, time_t t, char *ints, char *lang);
  64
  65 int ast_say_datetime_from_now(struct ast_channel *chan, time_t t, char *ints, char *lang);
  66
  67 #if defined(__cplusplus) || defined(c_plusplus)
  68 }
  69 #endif
  70
  71 #endif