6.4.  TN_DESC: Tone Description

The TN_DESC structure is declared as follows:

typedef struct {

   TN_FREQ            tn_freq;        /* input/output frequency structure */

   TN_DUR             tn_dur;         /* input/output duration structure  */

   unsigned short int tn_qualid;      /* output qualification ID          */

}  TN_DESC;

The TN_DESC structure specifies the characteristics of a tone.

The TN_DESC structure is used in two different parameters of the lm_LearnTone( ) function, and serves the following purposes:

• tn_rangep (input): Specifies optional tone learning boundaries as input to the lm_LearnTone( ) function, restricting learning to the specified range.
• tn_tonep (input): Specifies an existing tone description as optional input to the lm_LearnTone( ) function, and which learn mode incorporates in the final tone description.
• tn_tonep (output): Provides the final tone description that is returned by lm_LearnTone( ).

NOTE:

Set any field to 0 to use the default value.

Use the lm_clrdesc( ) function to clear the fields of a TN_DESC structure, including the fields in the TN_FREQ and TN_DUR structures.

Table 3.  TN_DESC Structure

Field	Description
tn_freq	Frequency Parameters. Specifies the frequency information in the TN_FREQ data structure. See TN_FREQ data structure.
tn_dur	Cadence Parameters. Specifies the cadence information in the TN_DUR data structure. See TN_DUR data structure.
tn_qualid	Length: 2 (unsigned short int) Default: QT_LMMID Output Qualification ID. Returns in tn_tonep the qualification ID associated with the tone description. This ID matches the input qualification ID specified in LM_PARM lm_qualid. Before creating the tone for global tone detection or call progress analysis, you must use the dx_selqual( ) function to select the qualification ID that is returned here. This field is not used for TN_DESC tn_tonep input or TN_DESC tn_rangep input.
	QT_LMLOW: Low qualification (poor line quality).
	QT_LMMID: Middle qualification (medium line quality).
	QT_LMHIGH: High qualification (high line quality).

Click here to contact Telecom Support Resources