Introduction

CDI_DTMFDETECTOR_PARMS

Dependent Functions

Data Structure

Parameter Fields

CDI_GLOBAL_PARMS

Dependent Functions

Data Structure

Parameter Fields

CDI_RING_PARMS

Dependent Functions

Data Structure

Parameter Fields

CDI_SIGNALDETECTOR_PARMS

Dependent Functions

Data Structure

Parameter Fields

CDI_TONE_PARMS

Dependent Functions

Data Structure

Parameter Fields

Introduction

The CDI service stores its parameters in data structures. The following sections describe each parameter these structures. The following structures are listed:

• CDI_DTMFDETECTOR_PARMS

• CDI_GLOBAL_PARMS

• CDI_RING_PARMS

• CDI_SIGNALDETECTOR_PARMS

• CDI_TONE_PARMS

Each section lists the data structure, lists the functions that are affected by the parameters in the structure, and provides detailed information about each parameter in the structure. The parameters are listed in alphabetical order.

The following CT Access functions obtain or modify parameter information:

Function	Description
ctaGetParmByName	Retrieves a single field for a given parameter name.
ctaSetParmByName	Modifies a single field for a given parameter name.
ctaGetParmInfo	Retrieves a parameter field definition.
ctaGetParms	Returns parameter values for a given parameter structure.
ctaRefreshParms	Resets the values of all context parameters on a CTA context to the global defaults.

For more information about parameter management in CT Access, see the CT Access Developer's Reference Manual.

CDI_DTMFDETECTOR_PARMS

The parameters in CDI_DTMFDETECTOR_PARMS control the behavior of the DTMF detector.

Dependent Functions

• cdiStartDTMFDetector

Data Structure

typedef struct
{
DWORD size;        /* Size of this structure                      */
DWORD onqualtime;        /* Minimum duration for DTMF detected          */
DWORD offqualtime;        /* Minimum duration for end of DTMF detected   */
DWORD DTMF_mode;        /* Mode of DTMF detection                      */
} CDI_DTMFDETECTOR_PARMS;

Parameter Fields

The CDI_DTMFDETECTOR_PARMS structure contains the following fields:

onqualtime

Type	DWORD
Units	ms
Default Value	30
Allowed Values	30-32766
Description	Minimum duration for a DTMF (in ms). Tones shorter than this duration are ignored.

offqualtime

Type	DWORD
Units	ms
Default Value	30
Allowed Values	30-32766
Description	Minimum duration of silence after a DTMF (in ms). If two identical DTMFs follow one another, and the interval of silence between the tones is shorter than offqualtime, the detector considers them a single DTMF instance.

DTMF_mode

Type	DWORD
Units	Flag
Default Value	0
Allowed Values	0,1
Description	Determines when the CDIEVN_DTMF_STARTED event is sent to the application, indicating that a DTMF tone has started: 0 Event is sent after the qualification time (onqualtime). 1 Event is sent when the key is released.

CDI_GLOBAL_PARMS

The CDI_GLOBAL_PARMS structure controls the general behavior of the DSP functions, setting enhanced mode on or off.

Dependent Functions

• cdiStartDTMFDetector

• cdiStartRing

• cdiStartTones

• cdiStartSignalDetector

Data Structure

typedef struct
{
 DWORD size;       /* Size of this structure                      */
DWORD EnhancedMode;        /* Enable/disable CX 2000 enhanced DSP features*/
} CDI_GLOBAL_PARMS;

Parameter Fields

The CDI_GLOBAL_PARMS structure contains the following field:

EnhancedMode

Type	DWORD
Units	Not applicable.
Default Value	1 (EnhancedMode enabled)
Allowed Values	0, 1
Description	The CX 2000 boards provide enhanced call control capabilities, such as the capabilities of the dependent functions listed. Enhanced mode should meet most developer's requirements. See Section 3.2, for more discussion of enhanced mode.

CDI_RING_PARMS

The parameters in CDI_RING_PARMS control the behavior of the ring.

Dependent Functions

• cdiStartRing

Data Structure

typedef struct
{
 DWORD size;       /* Size of this structure            */
 DWORD cadence_type;       /* Type of ring           */
} CDI_RING_PARMS;

Parameter Fields

The CDI_RING_PARMS structure contains the following field:

cadence_type

Type	DWORD
Units	Not applicable.
Default Value	0
Allowed Values	0, 1, 2
Description	Causes the station to ring using one of the three user-programmable cadence types (single, double, or triple ring). By convention, 0 is programmed to the national standard by the application. Refer to Section 3.5 for details.

CDI_SIGNALDETECTOR_PARMS

The parameters in CDI_SIGNALDETECTOR_PARMS configure the behavior of the signal detector (A and B bits).

Dependent Functions

• cdiStartSignalDetector

Data Structure

typedef struct
{
 DWORD size;       /* Size of this structure                   */
 DWORD timeon;       /* Off-hook deglitch time                   */
 DWORD timeoff;       /* On-hook deglitch time                    */
 DWORD min_flash_hook;       /* Minimum time to qualify for flash-hook   */
 DWORD max_flash_hook;       /* Beyond this time,                        */
        /* this is a disconnect condition           */
} CDI_SIGNALDETECTOR_PARMS;

Parameter Fields

The CDI_SIGNALDETECTOR_PARMS structure contains the following fields:

timeon

Type	DWORD
Units	ms
Default Value	30
Allowed Values	2-32766
Description	Sets the duration to qualify an off-hook condition.

timeoff

Type	DWORD
Units	ms
Default Value	30
Allowed Values	2-32766
Description	Sets the duration to qualify an on-hook condition.

min_flash_hook

Type	DWORD
Units	ms
Default Value	350
Allowed Values	2-32766
Description	Sets the duration to qualify a flash-hook condition.

max_flash_hook

Type	DWORD
Units	ms
Default Value	1000
Allowed Values	2-32766
Description	Sets the duration to qualify a disconnect condition.

CDI_TONE_PARMS

The parameters in CDI_TONE_PARMS control the behavior of the tones.

Dependent Functions

• cdiStartTones

Data Structure

typedef struct
{
 DWORD size;     /* Size of this structure                              */
 DWORD freq1;     /* First/only frequency of the generated tone          */
 DWORD freq2;     /* Second frequency of the generated tone              */
 INT32 ampl1;     /* Amplitude of the first/only frequency component     */
 INT32 ampl2;     /* Amplitude of the second frequency component         */
 DWORD ontime;     /* Duration of tone, single cadence generation         */
 DWORD offtime;     /* Duration of silence between tones, single cadence   */
 DWORD ontime2;     /* Duration of tone, double cadence generation         */
 DWORD offtime2;     /* Duration of silence between tones, double cadence   */
INT32 iterations;      /* Number of repeats of the tone/silence period        */
} CDI_TONE_PARMS;

Parameter Fields

The CDI_TONE_PARMS structure contains the following fields:

freq1

Type	DWORD
Units	Hz
Default Value	0
Allowed Values	0-4000
Description	A frequency component.

freq2

Type	DWORD
Units	Hz
Default Value	0
Allowed Values	0-4000
Description	A second frequency component, if the tone consists of two frequency components. Set to 0 if the tone consists of a single frequency only.

ampl1

Type	INT32
Units	dB
Default Value	0
Allowed Values	0 to -100
Description	The amplitude of freq1.

ampl2

Type	INT32
Units	dB
Default Value	0
Allowed Values	0 to -100
Description	The amplitude of freq2, in dB. Set to -100 if freq2 is 0.

ontime

Type	DWORD
Units	ms
Default Value	0
Allowed Values	0-8000
Description	The duration of the tone.

offtime

Type	DWORD
Units	ms
Default Value	0
Allowed Values	0-8000
Description	The duration of the silence after the tone, before the tone is repeated (because iterations and/or ontime2 are greater than 0).

ontime2

Type	DWORD
Units	ms
Default Value	0
Allowed Values	0-8000
Description	The duration of the second iteration of the tone, if the cadence consists of two iterations. Set to 0 if the cadence consists of one iteration only.

offtime2

Type	DWORD
Units	ms
Default Value	0
Allowed Values	0-8000
Description	The duration of the silence after the second iteration of the tone, before the cadence begins again. Set to 0 if the cadence consists of one iteration only.

iterations

Type	INT32
Units	Not applicable.
Default Value	-1
Allowed Values	-1 or [1-65535]
Description	The number of times to repeat the cadence. Set to -1 for infinite repeats.