Voice API for Windows Operating Systems Library Reference — November 2003 145
define a user-defined single-frequency cadenced tone — dx_bldstcad( )
dx_bldstcad( )define a user-defined single-frequency cadenced tone
!
!!
!Description
The dx_bldstcad( ) function defines a user-defined, single-frequency, cadenced tone. Subsequent
calls to dx_addtone( ) will use this tone, until another tone is defined. A single-frequency cadence
tone has single-frequency signals with specific on/off characteristics.
Issuing a dx_bldstcad( ) defines a new tone. You must use dx_addtone( ) to add the tone to the
channel and enable its detection.
For more information about global tone detection, see the Voice API Programming Guide.
Name: int dx_bldstcad(tid, freq, fqdev, ontime, ontdev, offtime, offtdev, repcnt)
Inputs: unsigned int tid •tone ID to assign
unsigned int freq •frequency in Hz
unsigned int fqdev •frequency deviation in Hz
unsigned int ontime •tone on time in 10 msec
unsigned int ontdev •on time deviation in 10 msec
unsigned int offtime •tone off time in 10 msec
unsigned int offtdev •off time deviation in 10 msec
unsigned int repcnt •repetitions if cadence
Returns: 0 if success
-1 if failure
Includes: srllib.h
dxxxlib.h
Category: Global Tone Detection
Mode: synchronous
Platform: DM3, Springware
Parameter Description
tid specifies a unique identifier for the tone. See Cautions for more information
about the tone ID.
freq specifies the frequency (in Hz) for the tone
frqdev specifies the allowable deviation (in Hz) for the frequency
ontime specifies the length of time for which the cadence is on (in 10 msec units)
ontdev specifies the allowable deviation for on time (in 10 msec units)
offtime specifies the length of time for which the cadence is off (in 10 msec units)