Table of Contents Index NMS Glossary Previous Page Next Page (Page 37 of 69 in this chapter) Version

adiStartDTMF

Description

Starts the generation of a string of DTMFs or MFs.

Prototype

DWORD adiStartDTMF ( CTAHD ctahd,
char *digits,
ADI_DTMF_PARMS *parms )

ctahd CTA context handle returned by ctaCreateContext.

digits Pointer to a string of DTMF digits including 0...9, A...F, *, # and `,' (comma) or `.' (period) for pauses (all other characters are ignored).

parms Pointer to DTMF parameters according to the following structure (NULL value uses the default values):

Note: In some instances, the dtmfofftime may increase by 20 ms.

typedef struct
{
DWORD size; /* size of this structure */

INT32 ampl1; /* level of first tone (dBm) */

INT32 ampl2; /* level of second tone (dBm) */

DWORD ontime; /* on duration of DTMF tone (ms) */

DWORD offtime; /* off duration of DTMF tone (ms) */

DWORD shortpause; /* duration of ',' (ms) */

DWORD longpause /* duration of '.' (ms) */

} ADI_DTMF_PARMS;

Return Values

Events

DSP File

For most AG hardware, this function requires that tone.dsp has been loaded. On AG 2000 boards and AG 4000/C boards, tone.m54 must be loaded to the board before adiStartDTMF will work. On CG 6000C boards, tone.f54 must be loaded to the board before adiStartDTMF will work. Refer to the board-specific installation and developer's manual for a table of MIPS usage for all functions.

For QX hardware, this function is supported in the standard DSP file. Refer to the QX Installation and Developer's Manual for a table of MIPS usage for all functions.

Details

This function starts generation of a sequence of DTMF tones or MF tones. Generation can be terminated using adiStopTones.

Note: While adiStartDTMF is active the DTMF detector is disabled.

digits may contain the following embedded escape characters that control the dialing sequence:
Character

 Description

.

 (period) Insert long pause in dialing.

,

 (comma) Insert short pause in dialing.

T

 Switch to DTMF dialing (default).

M

 Switch to MF dialing.

To generate MF tones, precede the string with an M.

For MF dialing, note the mapping to the U.S. MF digits:
Digit

 U.S. MF Name

0 to 9

 Specific digit address

B

 MF ST3P

C

 MF STP

D

 MF KP

E

 MF KP2, MF ST2P

F

 MF ST

See Also

adiStartTones, adiStopTones, adiStartMFDetector


Table of Contents Index NMS Glossary Previous Page Next Page (Page 37 of 69 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.