say.h File Reference

Say numbers and dates (maybe words one day too) More...

#include "asterisk/channel.h"
#include "asterisk/file.h"
#include <time.h>

Include dependency graph for say.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SAY_EXTERN   extern
#define	SAY_INIT(x)
	The basic ast_say_* functions are implemented as function pointers, initialized to the function say_stub() which simply returns an error. Other interfaces, declared here as regular functions, are simply wrappers around the basic functions. More...

Enumerations
enum	ast_say_case_sensitivity { AST_SAY_CASE_NONE , AST_SAY_CASE_LOWER , AST_SAY_CASE_UPPER , AST_SAY_CASE_ALL }
	Controls how ast_say_character_str denotes the case of characters in a string. More...

Functions
struct ast_str *	ast_get_character_str (const char *str, const char *lang, enum ast_say_case_sensitivity sensitivity)
	Returns an ast_str of files for SayAlpha playback. More...
struct ast_str *	ast_get_digit_str (const char *str, const char *lang)
	Returns an ast_str of files for SayDigits playback. More...
struct ast_str *	ast_get_money_str (const char *str, const char *lang)
	Returns an ast_str of files for SayMoney playback. More...
struct ast_str *	ast_get_number_str (int num, const char *lang)
	Returns an ast_str of files for SayNumber playback. More...
struct ast_str *	ast_get_ordinal_str (int num, const char *lang)
	Returns an ast_str of files for SayOrdinal playback. More...
struct ast_str *	ast_get_phonetic_str (const char *str, const char *lang)
	Returns an ast_str of files for SayPhonetic playback. More...
int	ast_say_character_str (struct ast_channel *chan, const char *num, const char *ints, const char *lang, enum ast_say_case_sensitivity sensitivity)
	function to pronounce character and phonetic strings More...
int	ast_say_counted_adjective (struct ast_channel *chan, int num, const char *adjective, const char *gender)
int	ast_say_counted_noun (struct ast_channel *chan, int num, const char *noun)
int	ast_say_digit_str (struct ast_channel *chan, const char *num, const char *ints, const char *lang)
	says digits of a string More...
int	ast_say_digits (struct ast_channel *chan, int num, const char *ints, const char *lang)
	says digits More...
int	ast_say_digits_full (struct ast_channel *chan, int num, const char *ints, const char *lang, int audiofd, int ctrlfd)
	Same as ast_say_digits() with audiofd for received audio and returns 1 on ctrlfd being readable. More...
int	ast_say_enumeration (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options)
	says an enumeration More...
int	ast_say_money_str (struct ast_channel *chan, const char *num, const char *ints, const char *lang)
	function to pronounce monetary amounts More...
int	ast_say_number (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options)
	says a number More...
int	ast_say_ordinal (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options)
	says an ordinal number More...
int	ast_say_phonetic_str (struct ast_channel *chan, const char *num, const char *ints, const char *lang)

Variables
SAY_EXTERN int(*	ast_say_character_str_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, enum ast_say_case_sensitivity sensitivity, int audiofd, int ctrlfd) SAY_INIT(ast_say_character_str_full)
SAY_EXTERN int(*	ast_say_date )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_date)
SAY_EXTERN 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) SAY_INIT(ast_say_date_with_format)
SAY_EXTERN int(*	ast_say_datetime )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime)
SAY_EXTERN int(*	ast_say_datetime_from_now )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime_from_now)
SAY_EXTERN int(*	ast_say_digit_str_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_digit_str_full)
	Same as ast_say_digit_str() with audiofd for received audio and returns 1 on ctrlfd being readable. More...
SAY_EXTERN int(*	ast_say_enumeration_full )(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_enumeration_full)
	Same as ast_say_enumeration() with audiofd for received audio and returns 1 on ctrlfd being readable. More...
SAY_EXTERN int(*	ast_say_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_full)
	the generic 'say' routine, with the first chars in the string defining the format to use More...
SAY_EXTERN int(*	ast_say_money_str_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_money_str_full)
SAY_EXTERN int(*	ast_say_number_full )(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_number_full)
	Same as ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable. More...
SAY_EXTERN int(*	ast_say_ordinal_full )(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_ordinal_full)
	Same as ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable. More...
SAY_EXTERN int(*	ast_say_phonetic_str_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_phonetic_str_full)
SAY_EXTERN int(*	ast_say_time )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_time)

Detailed Description

Say numbers and dates (maybe words one day too)

Definition in file say.h.

Macro Definition Documentation

SAY_EXTERN

#define SAY_EXTERN   extern

Definition at line 66 of file say.h.

SAY_INIT

#define SAY_INIT

(

x

)

The basic ast_say_* functions are implemented as function pointers, initialized to the function say_stub() which simply returns an error. Other interfaces, declared here as regular functions, are simply wrappers around the basic functions.

An implementation of the basic ast_say functions (e.g. from say.c or from a dynamically loaded module) will just have to reassign the pointers to the relevant functions to override the previous implementation.

Todo:

XXX As the conversion from the old implementation of say.c to the new implementation will be completed, and the API suitably reworked by removing redundant functions and/or arguments, this mechanism may be reverted back to pure static functions, if needed.

Definition at line 65 of file say.h.

Enumeration Type Documentation

ast_say_case_sensitivity

enum ast_say_case_sensitivity

Controls how ast_say_character_str denotes the case of characters in a string.

Enumerator
AST_SAY_CASE_NONE	Do not distinguish case on any letters
AST_SAY_CASE_LOWER	Denote case only on lower case letters, upper case is assumed otherwise
AST_SAY_CASE_UPPER	Denote case only on upper case letters, lower case is assumed otherwise
AST_SAY_CASE_ALL	Denote case on all letters, upper and lower

Definition at line 181 of file say.h.

                              {
    AST_SAY_CASE_NONE,  /*!< Do not distinguish case on any letters */
    AST_SAY_CASE_LOWER, /*!< Denote case only on lower case letters, upper case is assumed otherwise */
    AST_SAY_CASE_UPPER, /*!< Denote case only on upper case letters, lower case is assumed otherwise */
    AST_SAY_CASE_ALL,   /*!< Denote case on all letters, upper and lower */
};

Function Documentation

ast_get_character_str()

struct ast_str * ast_get_character_str	(	const char *	str,
		const char *	lang,
		enum ast_say_case_sensitivity	sensitivity
	)

Returns an ast_str of files for SayAlpha playback.

Parameters

str	Text to be translated to the corresponding audio files.
lang	Channel language
sensitivity	Case sensitivity

Computes the list of files to be played by SayAlpha.

Return values

ampersand-separated

string of Asterisk sound files that can be played back.

Definition at line 64 of file say.c.

                                                                                                                    {
    const char *fn;
    char fnbuf[10], asciibuf[20] = "letters/ascii";
    char ltr;
    int num = 0;
    int res = 0;
    int upper = 0;
    int lower = 0;
 
    struct ast_str *filenames = ast_str_create(20);
    if (!filenames) {
        return NULL;
    }
    ast_str_reset(filenames);
 
    while (str[num] && !res) {
        fn = NULL;
        switch (str[num]) {
        case ('*'):
            fn = "digits/star";
            break;
        case ('#'):
            fn = "digits/pound";
            break;
        case ('!'):
            fn = "letters/exclaimation-point";
            break;
        case ('@'):
            fn = "letters/at";
            break;
        case ('$'):
            fn = "letters/dollar";
            break;
        case ('-'):
            fn = "letters/dash";
            break;
        case ('.'):
            fn = "letters/dot";
            break;
        case ('='):
            fn = "letters/equals";
            break;
        case ('+'):
            fn = "letters/plus";
            break;
        case ('/'):
            fn = "letters/slash";
            break;
        case (' '):
            fn = "letters/space";
            break;
        case ('0'):
        case ('1'):
        case ('2'):
        case ('3'):
        case ('4'):
        case ('5'):
        case ('6'):
        case ('7'):
        case ('8'):
        case ('9'):
            strcpy(fnbuf, "digits/X");
            fnbuf[7] = str[num];
            fn = fnbuf;
            break;
        default:
            ltr = str[num];
            if ('A' <= ltr && ltr <= 'Z') {
                ltr += 'a' - 'A';       /* file names are all lower-case */
                switch (sensitivity) {
                case AST_SAY_CASE_UPPER:
                case AST_SAY_CASE_ALL:
                    upper = !upper;
                case AST_SAY_CASE_LOWER:
                case AST_SAY_CASE_NONE:
                    break;
                }
            } else if ('a' <= ltr && ltr <= 'z') {
                switch (sensitivity) {
                case AST_SAY_CASE_LOWER:
                case AST_SAY_CASE_ALL:
                    lower = !lower;
                case AST_SAY_CASE_UPPER:
                case AST_SAY_CASE_NONE:
                    break;
                }
            }
 
            if (upper) {
                strcpy(fnbuf, "uppercase");
            } else if (lower) {
                strcpy(fnbuf, "lowercase");
            } else {
                strcpy(fnbuf, "letters/X");
                fnbuf[8] = ltr;
            }
            fn = fnbuf;
        }
        if ((fn && ast_fileexists(fn, NULL, lang) > 0) ||
            (snprintf(asciibuf + 13, sizeof(asciibuf) - 13, "%d", str[num]) > 0 && ast_fileexists(asciibuf, NULL, lang) > 0 && (fn = asciibuf))) {
            ast_str_append(&filenames, 0, "%s%s", ast_str_strlen(filenames) ? "&" : "", fn);
        }
        if (upper || lower) {
            continue;
        }
        num++;
    }
 
    return filenames;
}

References ast_fileexists(), AST_SAY_CASE_ALL, AST_SAY_CASE_LOWER, AST_SAY_CASE_NONE, AST_SAY_CASE_UPPER, ast_str_append(), ast_str_create, ast_str_reset(), ast_str_strlen(), NULL, and str.

Referenced by say_character_str_full(), and sayfile_exec().

ast_get_digit_str()

struct ast_str * ast_get_digit_str	(	const char *	str,
		const char *	lang
	)

Returns an ast_str of files for SayDigits playback.

Parameters

str	Text to be translated to the corresponding audio files.
lang	Channel language

Computes the list of files to be played by SayDigits.

Return values

ampersand-separated

string of Asterisk sound files that can be played back.

Definition at line 300 of file say.c.

{
    const char *fn;
    char fnbuf[256];
    int num = 0;
 
    struct ast_str *filenames = ast_str_create(20);
    if (!filenames) {
        return NULL;
    }
    ast_str_reset(filenames);
 
    while (str[num]) {
        fn = NULL;
        switch (str[num]) {
        case ('*'):
            fn = "digits/star";
            break;
        case ('#'):
            fn = "digits/pound";
            break;
        case ('-'):
            fn = "digits/minus";
            break;
        case '0':
        case '1':
        case '2':
        case '3':
        case '4':
        case '5':
        case '6':
        case '7':
        case '8':
        case '9':
            strcpy(fnbuf, "digits/X");
            fnbuf[7] = str[num];
            fn = fnbuf;
            break;
        }
        if (fn && ast_fileexists(fn, NULL, lang) > 0) {
            ast_str_append(&filenames, 0, "%s%s", ast_str_strlen(filenames) ? "&" : "", fn);
        }
        num++;
    }
 
    return filenames;
}

References ast_fileexists(), ast_str_append(), ast_str_create, ast_str_reset(), ast_str_strlen(), NULL, and str.

Referenced by ast_get_money_en_dollars_str(), get_number_str_en(), say_digit_str_full(), and sayfile_exec().

ast_get_money_str()

struct ast_str * ast_get_money_str	(	const char *	str,
		const char *	lang
	)

Returns an ast_str of files for SayMoney playback.

Parameters

str	Text to be translated to the corresponding audio files.
lang	Channel language

Computes the list of files to be played by SayMoney.

Return values

ampersand-separated

string of Asterisk sound files that can be played back.

Returns an ast_str of files for SayMoney playback.

Definition at line 449 of file say.c.

{
    if (!strncasecmp(lang, "en", 2)) { /* English syntax */
        return ast_get_money_en_dollars_str(str, lang);
    }
 
    ast_log(LOG_WARNING, "Language %s not currently supported, defaulting to US Dollars\n", lang);
    /* Default to english */
    return ast_get_money_en_dollars_str(str, lang);
}

References ast_get_money_en_dollars_str(), ast_log, LOG_WARNING, and str.

Referenced by say_money_str_full(), and sayfile_exec().

ast_get_number_str()

struct ast_str * ast_get_number_str	(	int	num,
		const char *	lang
	)

Returns an ast_str of files for SayNumber playback.

Parameters

num	Integer to be translated to the corresponding audio files.
lang	Channel language

Computes the list of files to be played by SayNumber.

Return values

ampersand-separated

string of Asterisk sound files that can be played back.

Returns an ast_str of files for SayNumber playback.

Definition at line 566 of file say.c.

{
    if (!strncasecmp(lang, "en", 2)) { /* English syntax */
        return get_number_str_en(num, lang);
    }
 
    ast_log(LOG_WARNING, "Language %s not currently supported, defaulting to English\n", lang);
    /* Default to english */
    return get_number_str_en(num, lang);
}

References ast_log, get_number_str_en(), and LOG_WARNING.

Referenced by ast_get_money_en_dollars_str(), ast_say_number_full_en(), and sayfile_exec().

ast_get_ordinal_str()

struct ast_str * ast_get_ordinal_str	(	int	num,
		const char *	lang
	)

Returns an ast_str of files for SayOrdinal playback.

Parameters

num	Integer to be translated to the corresponding audio files.
lang	Channel language

Computes the list of files to be played by SayOrdinal.

Return values

ampersand-separated

string of Asterisk sound files that can be played back.

Returns an ast_str of files for SayOrdinal playback.

Definition at line 686 of file say.c.

{
    if (!strncasecmp(lang, "en", 2)) { /* English syntax */
        return get_ordinal_str_en(num, lang);
    }
 
    ast_log(LOG_WARNING, "Language %s not currently supported, defaulting to English\n", lang);
    /* Default to english */
    return get_ordinal_str_en(num, lang);
}

References ast_log, get_ordinal_str_en(), and LOG_WARNING.

Referenced by say_ordinal_full(), and sayfile_exec().

ast_get_phonetic_str()

struct ast_str * ast_get_phonetic_str	(	const char *	str,
		const char *	lang
	)

Returns an ast_str of files for SayPhonetic playback.

Parameters

str	Text to be translated to the corresponding audio files.
lang	Channel language

Computes the list of files to be played by SayPhonetic.

Return values

ampersand-separated

string of Asterisk sound files that can be played back.

Definition at line 216 of file say.c.

{
    const char *fn;
    char fnbuf[256];
    char ltr;
    int num = 0;
 
    struct ast_str *filenames = ast_str_create(20);
    if (!filenames) {
        return NULL;
    }
    ast_str_reset(filenames);
 
    while (str[num]) {
        fn = NULL;
        switch (str[num]) {
        case ('*'):
            fn = "digits/star";
            break;
        case ('#'):
            fn = "digits/pound";
            break;
        case ('!'):
            fn = "letters/exclaimation-point";
            break;
        case ('@'):
            fn = "letters/at";
            break;
        case ('$'):
            fn = "letters/dollar";
            break;
        case ('-'):
            fn = "letters/dash";
            break;
        case ('.'):
            fn = "letters/dot";
            break;
        case ('='):
            fn = "letters/equals";
            break;
        case ('+'):
            fn = "letters/plus";
            break;
        case ('/'):
            fn = "letters/slash";
            break;
        case (' '):
            fn = "letters/space";
            break;
        case ('0'):
        case ('1'):
        case ('2'):
        case ('3'):
        case ('4'):
        case ('5'):
        case ('6'):
        case ('7'):
        case ('8'):
            strcpy(fnbuf, "digits/X");
            fnbuf[7] = str[num];
            fn = fnbuf;
            break;
        default:    /* '9' falls here... */
            ltr = str[num];
            if ('A' <= ltr && ltr <= 'Z') ltr += 'a' - 'A';     /* file names are all lower-case */
            strcpy(fnbuf, "phonetic/X_p");
            fnbuf[9] = ltr;
            fn = fnbuf;
        }
        if (fn && ast_fileexists(fn, NULL, lang) > 0) {
            ast_str_append(&filenames, 0, "%s%s", ast_str_strlen(filenames) ? "&" : "", fn);
        }
        num++;
    }
 
    return filenames;
}

References ast_fileexists(), ast_str_append(), ast_str_create, ast_str_reset(), ast_str_strlen(), NULL, and str.

Referenced by say_phonetic_str_full(), and sayfile_exec().

ast_say_character_str()

int ast_say_character_str	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang,
		enum ast_say_case_sensitivity	sensitivity
	)

function to pronounce character and phonetic strings

Definition at line 8271 of file channel.c.

{
    return ast_say_character_str_full(chan, str, ints, lang, sensitivity, -1, -1);
}

References ast_say_character_str_full, and str.

Referenced by common_exec(), pbx_builtin_saycharacters(), pbx_builtin_saycharacters_case(), play_mailbox_owner(), play_on_channel(), and vmsayname_exec().

ast_say_counted_adjective()

int ast_say_counted_adjective	(	struct ast_channel *	chan,
		int	num,
		const char *	adjective,
		const char *	gender
	)

Referenced by saycountedadj_exec(), and vm_intro_multilang().

ast_say_counted_noun()

int ast_say_counted_noun	(	struct ast_channel *	chan,
		int	num,
		const char *	noun
	)

Referenced by saycountednoun_exec(), and vm_intro_multilang().

ast_say_digit_str()

int ast_say_digit_str	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang
	)

says digits of a string

Parameters

chan	channel to act upon
num	string to speak
ints	which dtmf to interrupt on
lang	language to speak in

Vocally says the digits of a given string

Return values

0	on succes
DTMF	if interrupted
-1	on failure

Definition at line 8259 of file channel.c.

{
    return ast_say_digit_str_full(chan, str, ints, lang, -1, -1);
}

References ast_say_digit_str_full, and str.

Referenced by __analog_ss_thread(), forward_message(), invent_message(), pbx_builtin_saydigits(), play_message_callerid(), and play_on_channel().

ast_say_digits()

int ast_say_digits	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang
	)

says digits

Parameters

chan	channel to act upon
num	number to speak
ints	which dtmf to interrupt on
lang	language to speak

Vocally says digits of a given number

Return values

0	on success
DTMF	if interrupted
-1	on failure

Definition at line 8253 of file channel.c.

{
    return ast_say_digits_full(chan, num, ints, lang, -1, -1);
}

References ast_say_digits_full().

Referenced by announce_to_dial(), common_exec(), conf_exec(), conf_run(), and say_parking_space().

ast_say_digits_full()

int ast_say_digits_full	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		int	audiofd,
		int	ctrlfd
	)

Same as ast_say_digits() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 8283 of file channel.c.

{
    char buf[256];
 
    snprintf(buf, sizeof(buf), "%d", num);
 
    return ast_say_digit_str_full(chan, buf, ints, lang, audiofd, ctrlfd);
}

References ast_say_digit_str_full, and buf.

Referenced by ast_say_digits(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_is(), ast_say_number_full_cs(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_is(), ast_say_number_full_it(), ast_say_number_full_ja(), ast_say_number_full_ka(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_th(), ast_say_number_full_ur(), ast_say_number_full_vi(), ast_say_number_full_zh(), and say_init_mode().

ast_say_enumeration()

int ast_say_enumeration	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options
	)

says an enumeration

Parameters

chan	channel to say them enumeration on
num	number to say on the channel
ints	which dtmf to interrupt on
lang	language to speak the enumeration
options	set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter

Vocally says an enumeration on a given channel (first, second, third, forth, thirtyfirst, hundredth, ....) Especially useful for dates and messages. Says 'last' if num equals to INT_MAX

Return values

0	on success
DTMF	digit on interrupt
-1	on failure

Definition at line 8247 of file channel.c.

{
    return ast_say_enumeration_full(chan, num, ints, language, options, -1, -1);
}

References ast_say_enumeration_full, language, and options.

Referenced by ast_say_date_da(), ast_say_date_de(), ast_say_date_is(), ast_say_date_with_format_da(), ast_say_date_with_format_de(), ast_say_date_with_format_en(), ast_say_date_with_format_is(), ast_say_date_with_format_pl(), and ast_say_date_with_format_vi().

ast_say_money_str()

int ast_say_money_str	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang
	)

function to pronounce monetary amounts

Definition at line 8265 of file channel.c.

{
    return ast_say_money_str_full(chan, str, ints, lang, -1, -1);
}

References ast_say_money_str_full, and str.

Referenced by pbx_builtin_saymoney().

ast_say_number()

int ast_say_number	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options
	)

says a number

Parameters

chan	channel to say them number on
num	number to say on the channel
ints	which dtmf to interrupt on
lang	language to speak the number
options	set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter

Vocally says a number on a given channel

Return values

0	on success
DTMF	digit on interrupt
-1	on failure

Examples

app_skel.c.

Definition at line 8235 of file channel.c.

{
    return ast_say_number_full(chan, num, ints, language, options, -1, -1);
}

References ast_say_number_full, language, and options.

Referenced by announce_user_count(), app_exec(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_gr(), ast_say_date_he(), ast_say_date_hu(), ast_say_date_is(), ast_say_date_ja(), ast_say_date_ka(), ast_say_date_nl(), ast_say_date_pt(), ast_say_date_th(), ast_say_date_with_format_da(), ast_say_date_with_format_de(), ast_say_date_with_format_en(), ast_say_date_with_format_es(), ast_say_date_with_format_fr(), ast_say_date_with_format_is(), ast_say_date_with_format_it(), ast_say_date_with_format_nl(), ast_say_date_with_format_pl(), ast_say_date_with_format_pt(), ast_say_date_with_format_th(), ast_say_date_with_format_vi(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_from_now_pt(), ast_say_datetime_he(), ast_say_datetime_ja(), ast_say_datetime_pt(), ast_say_datetime_th(), ast_say_datetime_zh(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_gr(), ast_say_time_hu(), ast_say_time_ja(), ast_say_time_ka(), ast_say_time_nl(), ast_say_time_pt(), ast_say_time_pt_BR(), ast_say_time_th(), ast_say_time_zh(), conf_run(), count_exec(), dictate_exec(), get_folder(), get_folder_ja(), gr_say_number_female(), limits_interval_playback(), meetme_menu_admin_extended(), pbx_builtin_saynumber(), play_message(), play_message_duration(), play_on_channel(), playback_common(), say_and_wait(), say_position(), try_calling(), vm_intro_gr(), vm_intro_he(), vm_intro_multilang(), vm_intro_pt(), and vm_intro_pt_BR().

ast_say_ordinal()

int ast_say_ordinal	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options
	)

says an ordinal number

Parameters

chan	channel to say them number on
num	ordinal number to say on the channel
ints	which dtmf to interrupt on
lang	language to speak the number
options	set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter

Vocally says an ordinal number on a given channel

Return values

0	on success
DTMF	digit on interrupt
-1	on failure

Definition at line 8241 of file channel.c.

{
    return ast_say_ordinal_full(chan, num, ints, language, options, -1, -1);
}

References ast_say_ordinal_full, language, and options.

Referenced by pbx_builtin_sayordinal().

ast_say_phonetic_str()

int ast_say_phonetic_str	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang
	)

Definition at line 8277 of file channel.c.

{
    return ast_say_phonetic_str_full(chan, str, ints, lang, -1, -1);
}

References ast_say_phonetic_str_full, and str.

Referenced by pbx_builtin_sayphonetic().

Variable Documentation

ast_say_character_str_full

SAY_EXTERN int(* ast_say_character_str_full) (struct ast_channel *chan, const char *num, const char *ints, const char *lang, enum ast_say_case_sensitivity sensitivity, int audiofd, int ctrlfd) SAY_INIT(ast_say_character_str_full)	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang,
		enum ast_say_case_sensitivity	sensitivity,
		int	audiofd,
		int	ctrlfd
	)

Definition at line 194 of file say.h.

Referenced by __say_init(), ast_say_character_str(), handle_sayalpha(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_date

SAY_EXTERN int(* ast_say_date) (struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_date)	(	struct ast_channel *	chan,
		time_t	t,
		const char *	ints,
		const char *	lang
	)

Definition at line 204 of file say.h.

Referenced by __say_init(), ast_say_datetime_de(), ast_say_datetime_hu(), ast_say_datetime_ka(), ast_say_datetime_nl(), ast_say_datetime_pt_BR(), handle_saydate(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_date_with_format

SAY_EXTERN 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) SAY_INIT(ast_say_date_with_format)	(	struct ast_channel *	chan,
		time_t	t,
		const char *	ints,
		const char *	lang,
		const char *	format,
		const char *	timezone
	)

Definition at line 208 of file say.h.

Referenced by __say_init(), ast_say_date_with_format_ja(), ast_say_date_with_format_pl(), handle_saydatetime(), play_message_datetime(), restore_say_mode(), save_say_mode(), say_init_mode(), and sayunixtime_exec().

ast_say_datetime

SAY_EXTERN int(* ast_say_datetime) (struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime)	(	struct ast_channel *	chan,
		time_t	t,
		const char *	ints,
		const char *	lang
	)

Definition at line 201 of file say.h.

Referenced by __say_init(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_datetime_from_now

SAY_EXTERN int(* ast_say_datetime_from_now) (struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime_from_now)	(	struct ast_channel *	chan,
		time_t	t,
		const char *	ints,
		const char *	lang
	)

Definition at line 206 of file say.h.

Referenced by __say_init(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_digit_str_full

SAY_EXTERN int(* ast_say_digit_str_full) (struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_digit_str_full)	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang,
		int	audiofd,
		int	ctrlfd
	)

Same as ast_say_digit_str() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 162 of file say.h.

Referenced by __say_init(), ast_say_digit_str(), ast_say_digits_full(), handle_saydigits(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_enumeration_full

SAY_EXTERN int(* ast_say_enumeration_full) (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_enumeration_full)	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options,
		int	audiofd,
		int	ctrlfd
	)

Same as ast_say_enumeration() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 125 of file say.h.

Referenced by __say_init(), ast_say_enumeration(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_full

SAY_EXTERN int(* ast_say_full) (struct ast_channel *chan, const char *num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_full)	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang,
		const char *	options,
		int	audiofd,
		int	ctrlfd
	)

the generic 'say' routine, with the first chars in the string defining the format to use

Definition at line 176 of file say.h.

ast_say_money_str_full

SAY_EXTERN int(* ast_say_money_str_full) (struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_money_str_full)	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang,
		int	audiofd,
		int	ctrlfd
	)

Definition at line 170 of file say.h.

Referenced by __say_init(), and ast_say_money_str().

ast_say_number_full

SAY_EXTERN int(* ast_say_number_full) (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_number_full)	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options,
		int	audiofd,
		int	ctrlfd
	)

Same as ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 86 of file say.h.

Referenced by __say_init(), ast_say_number(), handle_saynumber(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_ordinal_full

SAY_EXTERN int(* ast_say_ordinal_full) (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_ordinal_full)	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options,
		int	audiofd,
		int	ctrlfd
	)

Same as ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 105 of file say.h.

Referenced by __say_init(), and ast_say_ordinal().

ast_say_phonetic_str_full

SAY_EXTERN int(* ast_say_phonetic_str_full) (struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_phonetic_str_full)	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang,
		int	audiofd,
		int	ctrlfd
	)

Definition at line 199 of file say.h.

Referenced by __say_init(), ast_say_phonetic_str(), handle_sayphonetic(), restore_say_mode(), save_say_mode(), and say_init_mode().

ast_say_time

SAY_EXTERN int(* ast_say_time) (struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_time)	(	struct ast_channel *	chan,
		time_t	t,
		const char *	ints,
		const char *	lang
	)

Definition at line 202 of file say.h.

Referenced by __say_init(), ast_say_datetime_de(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_from_now_pt(), ast_say_datetime_hu(), ast_say_datetime_ka(), ast_say_datetime_nl(), ast_say_datetime_pt_BR(), handle_saytime(), restore_say_mode(), save_say_mode(), and say_init_mode().