Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 13 of 20 in this chapter) Version

cdiStartTones

Description

Starts the transmission of a single or double-cadenced dual tone.

Prototype

DWORD cdiStartTones (CTAHD ctahd,
CDI_TONE_PARMS *parms )
ctahd CTA context handle
parms Pointer to structure specifying frequency, cadence and iterations of tone:

typedef structS
{
DWORD size;
DWORD freq1;
DWORD freq2;
INT32 ampl1;
INT32 ampl2;
DWORD ontime;
DWORD offtime;
DWORD ontime2;
DWORD offtime2;
INT32 iterations;
} CDI_TONE_PARM

Return Values

SUCCESS
CDIERR_INVALID_CALL_STATE
The port must be off-hook to invoke this function.
CTAERR_FUNCTION_ACTIVE
This function cannot be invoked twice.
CTAERR_INVALID_CTAHD
The CTA handle is invalid.
CTAERR_BAD_ARGUMENT
An argument is not in the valid range.

Events

CDIEVN_TONE_DONE
The tone transmission is complete.

Details

When a station is off-hook, you can cause your board to transmit tones to the station. Each tone can consist of one or two frequency components, each at different amplitudes. You can also set up a pattern (cadence) of up to two iterations of the tone, each of different lengths.
To start the transmission of a tone, invoke cdiStartTones. In the invocation, pass a pointer to the CDI_TONE_PARMS structure. The following table describes the parameters in this structure: Parameter Description Valid Values freq1 A frequency component (in Hz). 0 to 4000 freq2 A second frequency component (in Hz), if the tone consists of two frequency components. Set to 0 if the tone consists of a single frequency only. 0 to 4000 ampl1 The amplitude of freq1, in dB. 0 to -100 ampl2 The amplitude of freq2, in dB. Set to -100 if freq2 is 0. 0 to -100 ontime The duration of the tone, in ms. 0 to 8000 offtime The duration of the silence after the tone (in ms), before the tone is repeated (because iterations and/or ontime2 are greater than 0). 0 to 8000 ontime2 The duration of the second iteration of the tone (in ms), if the cadence consists of two iterations. Set to 0 if the cadence consists of one iteration only. 0 to 8000 offtime2 The duration of the silence after the second iteration of the tone (in ms), before the cadence begins again. Set to 0 if the cadence consists of one iteration only. 0 to 8000 iterations The number of times to repeat the cadence. Set to -1 for infinite repeats. -1, or (1 to 65535)
When enhanced mode is enabled, the DSP automatically stops tones upon detection of on-hook or DTMF. Otherwise, invoke cdiStopTones to stop an ongoing tone. (Refer to Section 3.2 for more information about enhanced mode.) Note: If the board enters Protection state (due to overheating), all stations receive an alarm tone indicating maintenance attention is needed. This tone overrides any other tones.
For more information about tone generation, refer to Section 3.7.

See Also

cdiStopTones

Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 13 of 20 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.