(Page 54 of 80 in this chapter)
adiStartPulse
Description
- Starts the generation of an out-of-band pulse.
Prototype
- DWORD adiStartPulse( CTAHD ctahd,
unsigned signal,
unsigned timeon,
unsigned timeoff )
- ctahd Context handle returned by adiOpenPort.
- 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 Requirement
- This function requires that signal.dsp has been loaded by agmon.
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 (e.g., generate a flash hook).
- 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, that is, 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 54 of 80 in this chapter)
Tech_Support@nmss.com
Copyright © 1996, Natural MicroSystems, Inc. All rights
reserved.