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


adiStartDial

Description

Starts the dialing function for the applications not using protocol-independent call control.

Prototype

DWORD adiStartDial ( CTAHD ctahd,
char *digitstr,
ADI_DIAL_PARMS *parms )

ctahd CTA context handle returned by ctaCreateContext.

digitstr Pointer to string of digits to be dialed.

parms Pointer to dialing parameters, stored in ADI_DIAL_PARMS structure as follows (NULL designates default values):

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

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

DWORD method;

/* default dialing method: 0=DTMF, 1=pulse, 2=MF */

DWORD breaktime; /* duration of pulse digit break (ms) */

DWORD maketime; /* duration of pulse digit make (ms) */

DWORD interpulse;

/*interdigit delay between pulsed digits (ms) */

DWORD flashtime; /* duration of the flash-hook (ms) */

DWORD shortpause;

/* duration of the comma in dialing string (ms) */

DWORD longpause;

/* duration of the dot in dialing string (ms) */

INT32 dtmfampl1; /* first dtmf amplitude (dBm) */

INT32 dtmfampl2; /* second dtmf amplitude (dBm) */

DWORD dtmfontime; /* ON duration of DTMFs (ms) */

DWORD dtmfofftime; /* OFF duration of DTMFs (ms) */

DWORD dialtonewait;

/* max time to wait for dialtone (ms) on ';' */

/* precise dialtone parameters: */

DWORD tonefreq1; /* frequency to detect */

DWORD tonebandw1; /* bandwidth */

DWORD tonefreq2; /* 2nd frequency to detect (dualtone) */

DWORD tonebandw2; /* 2nd bandwidth */

INT32 tonequalampl; /* broadband qual level (in dBm) */

DWORD tonequaltime; /* qualification time (in ms) */

DWORD tonereflevel; /* reserved */

DWORD reserved; /* reserved, must be 0 */
DWORD tonetotaltime;

/* total time for dial tone with interruptions */

} ADI_DIAL_PARMS;

Return Values

Events

DSP File

For AG and CG hardware, this function may require one or more of the following DSP files to be loaded depending on the digitstr and related parameters:
CG 6000C

AG Boards
(general)

AG 2000 and
AG 4000/C boards

Usage

tone.f54

tone.dsp

tone.m54

Generating DTMF and MF tones.

signal.dsp (except AG Dual/Quad)

signal.m54
(AG 2000 only)

Generating pulse digits.

ptf.f54

callp.dsp

ptf.m54

Precise dial tone detection.

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 functions starts the dialing function. This function should not be confused with adiPlaceCall, which should be called when using standard call control. adiStartDial is provided mainly for NOCC users. adiStartDial is similar to adiStartDTMF, but also allows access to pulse-dialing, flashing, and precise dial tone detection.

If you need to generate DTMFs while in the Conversation state (ADI_CC_STATE_CONNECTED) and using standard call control, use adiStartDTMF.

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

digitstr may contain the following embedded escape characters which control the dialing sequence, as listed below:
Character

Description

;

(semicolon) Wait for precise dial tone.

.

(period) Insert long pause in dialing.

,

(comma) Insert short pause in dialing.

!

Flash hook.

P

Switch to pulse dialing.

T

Switch to DTMF dialing.

M

Switch to MF dialing.

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

NOCC users might consider starting a call progress analysis operation (adiStartCallProgress) after receiving the DONE event.

After calling adiStartDial, expect a DONE event. If the function is dialing DTMFs, the outbound voice path must be available (that is, not in use by another function). If the function is pulse dialing, the outbound signaling path must be available.

See Also

adiStopDial, adiStartDTMF, adiPlaceCall, adiStartProtocol, adiStartMFDetector



Table of Contents Index NMS Glossary Previous Page Next Page (Page 36 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.