Asterisk - The Open Source Telephony Project GIT-master-d856a3e
Data Fields
ast_tone_zone Struct Reference

A set of tones for a given locale. More...

#include <indications.h>

Collaboration diagram for ast_tone_zone:
Collaboration graph
[legend]

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.

Definition at line 74 of file indications.h.

Field Documentation

◆ 

union { ... } @236

Flags only used internally.

◆ __padding

uint32_t __padding

Definition at line 96 of file indications.h.

◆ country

char country[MAX_TONEZONE_COUNTRY]

◆ 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 is_valid_tone_zone(), Api::load(), ResourceApi::load(), Model::load(), Parameter::load(), Property::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

◆ 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(), reset_tone_zone(), and store_tone_zone_ring_cadence().

◆ 

struct { ... } tones

The documentation for this struct was generated from the following file: