sysmocom/asterisk
11
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Doxygen documentationification

Browse source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@49095 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Olle Johansson 2007-01-01 20:08:47 +00:00
parent e5b5a92a56
commit 43e0695bd0
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
include/asterisk/indications.h
View file

@ -34,51 +34,51 @@
#include "asterisk/lock.h" #include "asterisk/lock.h"
struct ind_tone_zone_sound { /*! \brief Description is a series of tones of the format:
struct ind_tone_zone_sound *next; /* next element */
const char *name; /* Identifing name */
const char *data; /* Actual zone description */
/* Description is a series of tones of the format:
[!]freq1[+freq2][/duration] separated by commas. There [!]freq1[+freq2][/duration] separated by commas. There
are no spaces. The sequence is repeated back to the are no spaces. The sequence is repeated back to the
first tone description not preceeded by !. Duration is first tone description not preceeded by !. Duration is
specified in milliseconds */ specified in milliseconds */
struct ind_tone_zone_sound {
struct ind_tone_zone_sound *next; /*!< next element */
const char *name; /*!< Identifing name */
const char *data; /*!< Actual zone description */
}; };
struct ind_tone_zone { struct ind_tone_zone {
AST_RWLIST_ENTRY(ind_tone_zone) list; AST_RWLIST_ENTRY(ind_tone_zone) list;
char country[5]; /* Country code */ char country[5]; /*!< Country code */
char alias[5]; /* is this an alias? */ char alias[5]; /*!< is this an alias? */
char description[40]; /* Description */ char description[40]; /*!< Description */
int nrringcadence; /* # registered ringcadence elements */ int nrringcadence; /*!< # registered ringcadence elements */
int *ringcadence; /* Ring cadence */ int *ringcadence; /*!< Ring cadence */
struct ind_tone_zone_sound *tones; /* The known tones for this zone */ struct ind_tone_zone_sound *tones; /*!< The known tones for this zone */
}; };
/* set the default tone country */ /*! \brief set the default tone country */
int ast_set_indication_country(const char *country); int ast_set_indication_country(const char *country);
/* locate tone_zone, given the country. if country == NULL, use the default country */ /*! \brief locate tone_zone, given the country. if country == NULL, use the default country */
struct ind_tone_zone *ast_get_indication_zone(const char *country); struct ind_tone_zone *ast_get_indication_zone(const char *country);
/* locate a tone_zone_sound, given the tone_zone. if tone_zone == NULL, use the default tone_zone */ /*! \brief locate a tone_zone_sound, given the tone_zone. if tone_zone == NULL, use the default tone_zone */
struct ind_tone_zone_sound *ast_get_indication_tone(const struct ind_tone_zone *zone, const char *indication); struct ind_tone_zone_sound *ast_get_indication_tone(const struct ind_tone_zone *zone, const char *indication);
/* add a new country, if country exists, it will be replaced. */ /*! \brief add a new country, if country exists, it will be replaced. */
int ast_register_indication_country(struct ind_tone_zone *country); int ast_register_indication_country(struct ind_tone_zone *country);
/* remove an existing country and all its indications, country must exist */ /*! \brief remove an existing country and all its indications, country must exist */
int ast_unregister_indication_country(const char *country); int ast_unregister_indication_country(const char *country);
/* add a new indication to a tone_zone. tone_zone must exist. if the indication already /*! \brief add a new indication to a tone_zone. tone_zone must exist. if the indication already
* exists, it will be replaced. */ * exists, it will be replaced. */
int ast_register_indication(struct ind_tone_zone *zone, const char *indication, const char *tonelist); int ast_register_indication(struct ind_tone_zone *zone, const char *indication, const char *tonelist);
/* remove an existing tone_zone's indication. tone_zone must exist */ /*! \brief remove an existing tone_zone's indication. tone_zone must exist */
int ast_unregister_indication(struct ind_tone_zone *zone, const char *indication); int ast_unregister_indication(struct ind_tone_zone *zone, const char *indication);
/* Start a tone-list going */ /*! \brief Start a tone-list going */
int ast_playtones_start(struct ast_channel *chan, int vol, const char* tonelist, int interruptible); int ast_playtones_start(struct ast_channel *chan, int vol, const char* tonelist, int interruptible);
/*! Stop the tones from playing */ /*! \brief Stop the tones from playing */
void ast_playtones_stop(struct ast_channel *chan); void ast_playtones_stop(struct ast_channel *chan);
/* support for walking through a list of indications */ /*! \brief support for walking through a list of indications */
struct ind_tone_zone *ast_walk_indications(const struct ind_tone_zone *cur); struct ind_tone_zone *ast_walk_indications(const struct ind_tone_zone *cur);
#if 0 #if 0