summaryrefslogtreecommitdiff
path: root/include/asterisk/say.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/asterisk/say.h')
-rwxr-xr-xinclude/asterisk/say.h35
1 files changed, 32 insertions, 3 deletions
diff --git a/include/asterisk/say.h b/include/asterisk/say.h
index cc54a060a..293f113e5 100755
--- a/include/asterisk/say.h
+++ b/include/asterisk/say.h
@@ -21,9 +21,38 @@
extern "C" {
#endif
-int ast_say_number(struct ast_channel *chan, int num, char *lang);
-int ast_say_digits(struct ast_channel *chan, int num, char *lang);
-int ast_say_digit_str(struct ast_channel *chan, char *num, char *lang);
+//! 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
+ * 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);
+
+//! says digits
+/*!
+ * \param chan channel to act upon
+ * \param num number to speak
+ * \param ints which dtmf to interrupt on
+ * \param lang language to speak
+ * 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);
+
+//! says digits of a string
+/*!
+ * \param chan channel to act upon
+ * \param num string to speak
+ * \param ints which dtmf to interrupt on
+ * \param lang language to speak in
+ * 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);
#if defined(__cplusplus) || defined(c_plusplus)
}