diff options
Diffstat (limited to 'include/asterisk/say.h')
| -rwxr-xr-x | include/asterisk/say.h | 54 |
1 files changed, 32 insertions, 22 deletions
diff --git a/include/asterisk/say.h b/include/asterisk/say.h index e8b235e17..52197d4ea 100755 --- a/include/asterisk/say.h +++ b/include/asterisk/say.h @@ -23,23 +23,34 @@ extern "C" { #endif -//! says a number -/*! +/* says a number * \param chan channel to say them number on * \param num number to say on the channel * \param ints which dtmf to interrupt on * \param lang language to speak the number - * \param options set to 'f' for female, 'm' for masculine (used in portuguese) + * \param options set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter, 'p' for plural * Vocally says a number on a given channel * Returns 0 on success, DTMF digit on interrupt, -1 on failure */ -int ast_say_number(struct ast_channel *chan, int num, char *ints, char *lang, char *options); +int ast_say_number(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options); /* Same as above with audiofd for received audio and returns 1 on ctrlfd being readable */ -int ast_say_number_full(struct ast_channel *chan, int num, char *ints, char *lang, char *options, int audiofd, int ctrlfd); +int ast_say_number_full(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd); -//! says digits -/*! +/* says an enumeration + * \param chan channel to say them enumeration on + * \param num number to say on the channel + * \param ints which dtmf to interrupt on + * \param lang language to speak the enumeration + * \param options set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter, 'p' for plural + * Vocally says a enumeration on a given channel (first, sencond, third, forth, thirtyfirst, hundredth, ....) + * especially useful for dates and messages. says 'last' if num equals to INT_MAX + * Returns 0 on success, DTMF digit on interrupt, -1 on failure + */ +int ast_say_enumeration(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options); +int ast_say_enumeration_full(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd); + +/* says digits * \param chan channel to act upon * \param num number to speak * \param ints which dtmf to interrupt on @@ -47,11 +58,10 @@ int ast_say_number_full(struct ast_channel *chan, int num, char *ints, char *lan * Vocally says digits of a given number * Returns 0 on success, dtmf if interrupted, -1 on failure */ -int ast_say_digits(struct ast_channel *chan, int num, char *ints, char *lang); -int ast_say_digits_full(struct ast_channel *chan, int num, char *ints, char *lang, int audiofd, int ctrlfd); +int ast_say_digits(struct ast_channel *chan, int num, const char *ints, const char *lang); +int ast_say_digits_full(struct ast_channel *chan, int num, const char *ints, const char *lang, int audiofd, int ctrlfd); -//! says digits of a string -/*! +/* says digits of a string * \param chan channel to act upon * \param num string to speak * \param ints which dtmf to interrupt on @@ -59,22 +69,22 @@ int ast_say_digits_full(struct ast_channel *chan, int num, char *ints, char *lan * Vocally says the digits of a given string * Returns 0 on success, dtmf if interrupted, -1 on failure */ -int ast_say_digit_str(struct ast_channel *chan, char *num, char *ints, char *lang); -int ast_say_digit_str_full(struct ast_channel *chan, char *num, char *ints, char *lang, int audiofd, int ctrlfd); -int ast_say_character_str(struct ast_channel *chan, char *num, char *ints, char *lang); -int ast_say_character_str_full(struct ast_channel *chan, char *num, char *ints, char *lang, int audiofd, int ctrlfd); -int ast_say_phonetic_str(struct ast_channel *chan, char *num, char *ints, char *lang); -int ast_say_phonetic_str_full(struct ast_channel *chan, char *num, char *ints, char *lang, int audiofd, int ctrlfd); +int ast_say_digit_str(struct ast_channel *chan, const char *num, const char *ints, const char *lang); +int ast_say_digit_str_full(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd); +int ast_say_character_str(struct ast_channel *chan, const char *num, const char *ints, const char *lang); +int ast_say_character_str_full(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd); +int ast_say_phonetic_str(struct ast_channel *chan, const char *num, const char *ints, const char *lang); +int ast_say_phonetic_str_full(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd); -int ast_say_datetime(struct ast_channel *chan, time_t t, char *ints, char *lang); +int ast_say_datetime(struct ast_channel *chan, time_t t, const char *ints, const char *lang); -int ast_say_time(struct ast_channel *chan, time_t t, char *ints, char *lang); +int ast_say_time(struct ast_channel *chan, time_t t, const char *ints, const char *lang); -int ast_say_date(struct ast_channel *chan, time_t t, char *ints, char *lang); +int ast_say_date(struct ast_channel *chan, time_t t, const char *ints, const char *lang); -int ast_say_datetime_from_now(struct ast_channel *chan, time_t t, char *ints, char *lang); +int ast_say_datetime_from_now(struct ast_channel *chan, time_t t, const char *ints, const char *lang); -int ast_say_date_with_format(struct ast_channel *chan, time_t t, char *ints, char *lang, char *format, char *timezone); +int ast_say_date_with_format(struct ast_channel *chan, time_t t, const char *ints, const char *lang, const char *format, const char *timezone); #if defined(__cplusplus) || defined(c_plusplus) } |