Filter
Top Products
Voice API for Windows Operating Systems Library Reference — November 2003 533
tone information — TONE_DATA
TONE_DATA
tone information
typedef struct {
unsigned int structver; /* version of TONE_SEG struct */
unsigned short tn_dflag; /* Dual Tone - 1, Single Tone - 0 */
unsigned short tn1_min; /* Min. Frequency for Tone 1 (in Hz) */
unsigned short tn1_max; /* Max. Frequency for Tone 1 (in Hz) */
unsigned short tn2_min; /* Min. Frequency for Tone 2 (in Hz) */
unsigned short tn2_max; /* Max. Frequency for Tone 2 (in Hz) */
unsigned short tn_twinmin; /* Min. Frequency for twin of dual tone (in Hz) */
unsigned short tn_twinmax; /* Max. Frequency for twin of dual tone (in Hz) */
unsigned short tnon_min; /* Debounce Min. ON Time (in 10msec units) */
unsigned short tnon_max; /* Debounce Max. ON Time (in 10msec units) */
unsigned short tnoff_min; /* Debounce Min. OFF Time (in 10msec units) */
unsigned short tnoff_max; /* Debounce Max. OFF Time (in 10msec units) */
} TONE_SEG;
typedef struct {
unsigned int structver; /* version of TONE_DATA struct */
unsigned short tn_rep_cnt; /* Debounce Rep Count */
unsigned int numofseg; /* Number of segments for a MultiSegment Tone */
TONE_SEG toneseg[6];
} TONE_DATA
!
!!
! Description
The TONE_DATA data structure contains tone information for a specific call progress tone. This
structure is used by the dx_createtone( ) function. This structure is defined in dxxxlib.h. For
information on call progress analysis and default tone definitions, see the Voice API Programming
Guide.
The TONE_DATA structure includes the TONE_SEG substructure as 6 instances called toneseg.
Note: Be sure to set all unused fields in the structure to 0 before using this structure in a function call.
This action prevents possible corruption of data in the allocated memory space.
!
!!
! Field Descriptions
The fields of the TONE_DATA structure are described as follows:
TONE_SEG.structver
Specifies the version of the TONE_SEG structure. Used to ensure that an application is binary
compatible with future changes to this data structure.
TONE_SEG.tn_dflag
Specifies whether the tone is dual tone or single tone. Values are 1 for dual tone and 0 for
single tone.
TONE_SEG.tn1_min
Specifies the minimum frequency in Hz for tone 1.
TONE_SEG.tn1_max
Specifies the maximum frequency in Hz for tone 1.
TONE_SEG.tn2_min
Specifies the minimum frequency in Hz for tone 2.