Intel 05-1832-002 User Manual

Page of 564
142
Voice API for Windows Operating Systems Library Reference — November 2003
dx_bldst( ) — define a user-defined single-frequency tone
dx_bldst( )
define a user-defined single-frequency tone
!
!
!
Description
The dx_bldst( ) function defines a user-defined single-frequency tone. Subsequent calls to 
dx_addtone( ) will use this tone, until another tone is defined.
Issuing a dx_bldst( ) defines a new tone. You must use 
 to add the tone to the 
channel and enable its detection.
For more information about global tone detection, see the Voice API Programming Guide
!
!
!
Cautions
Only one tone per application may be defined at any time. dx_bldst( ) will replace the 
previous user-defined tone definition.
Do not use tone IDs 261, 262 and 263; they are reserved for library use.
Name:
int dx_bldst(tid, freq, fqdev, mode)
Inputs:
unsigned int tid
tone ID to assign
unsigned int freq
frequency in Hz
unsigned int fqdev
frequency deviation in Hz
unsigned int mode
leading or trailing edge
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
mode 
specifies whether detection is on the leading or trailing edge of the tone. Set to 
one of the following:
TN_LEADING
TN_TRAILING