A set of tones for a given locale. More...
#include <indications.h>
Data Fields | |
| union { | |
| struct { | |
| unsigned int killme:1 | |
| } | |
| uint32_t __padding | |
| }; | |
| Flags only used internally. More... | |
| char | country [MAX_TONEZONE_COUNTRY] |
| Country code that this set of tones is for. More... | |
| char | description [40] |
| Text description of the given country. More... | |
| unsigned int | nrringcadence |
| Number of ring cadence elements in the ringcadence array. More... | |
| int * | ringcadence |
| Array of ring cadence parts. More... | |
| struct { | |
| struct ast_tone_zone_sound * first | |
| struct ast_tone_zone_sound * last | |
| } | tones |
| A list of tones for this locale. More... | |
Detailed Description
A set of tones for a given locale.
- Note
- If a reference to this tone zone is held, then the country is guaranteed not to change. It is safe to read it without locking the tone zone. This is not the case for any other field.
- Examples:
- /usr/src/asterisk-18.5.0/main/app.c.
Definition at line 74 of file indications.h.
Field Documentation
◆ @273
| union { ... } |
Flags only used internally.
◆ __padding
| uint32_t __padding |
Definition at line 96 of file indications.h.
◆ country
| char country[MAX_TONEZONE_COUNTRY] |
Country code that this set of tones is for.
Definition at line 76 of file indications.h.
Referenced by ast_get_indication_zone(), ast_register_indication_country(), ast_tone_zone_cmp(), ast_tone_zone_hash(), ast_unregister_indication_country(), ast_var_indications(), ast_var_indications_table(), complete_country(), complete_indications(), handle_cli_indication_add(), handle_cli_indication_show(), parse_tone_zone(), and send_dial_tone().
◆ description
| char description[40] |
Text description of the given country.
This is for nothing more than friendly display to a human.
Definition at line 82 of file indications.h.
Referenced by ast_var_indications_table(), handle_cli_indication_show(), is_valid_tone_zone(), Parameter::load(), Api::load(), Property::load(), Model::load(), ResourceApi::load(), and store_config_tone_zone().
◆ first
| struct ast_tone_zone_sound* first |
Definition at line 93 of file indications.h.
◆ killme
| unsigned int killme |
Definition at line 98 of file indications.h.
Referenced by prune_tone_zone(), reset_tone_zone(), and tone_zone_mark().
◆ last
| struct ast_tone_zone_sound* last |
Definition at line 93 of file indications.h.
◆ nrringcadence
| unsigned int nrringcadence |
Number of ring cadence elements in the ringcadence array.
Definition at line 84 of file indications.h.
Referenced by ast_get_indication_zone(), ast_unregister_indication_country(), complete_indications(), handle_cli_indication_show(), parse_tone_zone(), reset_tone_zone(), and store_tone_zone_ring_cadence().
◆ ringcadence
| int* ringcadence |
Array of ring cadence parts.
Each element is an amount of time in milliseconds. The first element is for time on, and from there it alternates between on and off.
Definition at line 91 of file indications.h.
Referenced by ast_tone_zone_destructor(), handle_cli_indication_show(), reset_tone_zone(), and store_tone_zone_ring_cadence().
◆ tones
| struct { ... } tones |
A list of tones for this locale.
Referenced by ast_get_indication_tone(), ast_register_indication(), ast_tone_zone_destructor(), ast_unregister_indication(), complete_indications(), handle_cli_indication_show(), is_valid_tone_zone(), prune_tone_zone(), and tone_zone_mark().
The documentation for this struct was generated from the following file:
