(Page 43 of 69 in this chapter) Version
adiStartPulse
Description
- Starts the generation of an out-of-band pulse.
Prototype
- DWORD adiStartPulse ( CTAHD ctahd,
unsigned signal,
unsigned timeon,
unsigned timeoff )
- ctahd CTA context handle returned by ctaCreateContext.
- signal Bit mask/pattern to "pulse" (assert temporarily), which is a combination of the following constants:
- ADI_A_BIT (0x8), ADI_B_BIT (0x4),
ADI_C_BIT (0x2), ADI_D_BIT (0x1),
or zero (0).
- timeon Duration of the pulse (in milliseconds) with the pattern activated.
- timeoff Duration after the pulse (in milliseconds), before the DONE event is sent.
Return Values
Events
DSP File
- This function requires that signal.dsp has been loaded for AG 24/30/48/60 boards and for AG E1/T1 boards. It is not required for the AG Quad boards. The AG 2000 board requires that signal.m54 has been loaded.
- For QX hardware, this function is supported in the standard DSP file.
Details
- This function outputs the specified signaling bit pattern for a precise duration. This function is non-blocking and returns back to the application immediately after starting the pulse.
- The out-of-band signal pattern is either the physical out-of-band signal bits of a digital protocol or it relates to the control of an analog interface board. In both cases, four signaling bits, A, B, C, and D, often written as ABCD, and defined by a bit mask (0x8, 0x4, 0x2, and 0x1, respectively), are used. The following constants are in adidef.h and can be ORed to define any group of bits: ADI_A_BIT, ADI_B_BIT, ADI_C_BIT, and ADI_D_BIT. For example, if the line is off-hook, a zero may be pulsed (for example, generate a flash hook).
- When using adiAssertSignal and adiStartPulse on an AG-T1 board configured for D4 framing, ensure that the C bit and the D bit are set the same as the A bit and the B bit. Otherwise, the received A bit and B bit at the remote end will be in an intermediate state.
- For example, to pulse the A bit high and the B bit low, call adiStartPulse as follows:
- adiStartPulse (ctahd, ADI_A_BIT | ADI_C_BIT);
- When using this function with an analog interface board, refer to the hardware reference manual for your analog interface board for specific information on how the A and B bits affect the telephone line.
- This function is not available if the current protocol reserves use of out-of-band signaling. Typically, call control protocols take over the line signaling and the application doesn't need to assert or reset line codes or pulses explicitly.
- adiStartPulse overrides adiAssertSignal
. For the duration of the pulse, the line pattern will be determined by the signaling state specified by adiStartPulse, and then it will revert to the pattern previously asserted by adiAssertSignal.
See Also
- adiAssertSignal
(Page 43 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.