Filter
Top Products
Voice API for Windows Operating Systems Library Reference — November 2003 197
disable detection of a user-defined tone — dx_distone( )
dx_distone( )
disable detection of a user-defined tone
!
!!
! Description
The dx_distone( ) function disables detection of a user-defined tone on a channel, as well as the
tone-on and tone-off events for that tone. Detection capability for user-defined tones is enabled on
a channel by default when dx_addtone( ) is called.
!
!!
! Cautions
When using this function in a multi-threaded application, use critical sections or a semaphore
around the function call to ensure a thread-safe application. Failure to do so will result in “Bad
Tone Template ID” errors.
Name: int dx_distone(chdev, toneid, evt_mask)
Inputs: int chdev
• valid channel device handle
int toneid
• tone template identification
int evt_mask
• event mask
Returns: 0 if success
-1 if error
Includes: srllib.h
dxxxlib.h
Category: Global Tone Detection
Mode: synchronous
Platform: DM3, Springware
Parameter Description
chdev specifies the valid channel device handle obtained when the channel was
opened using dx_open( )
toneid specifies the user-defined tone identifier for which detection is being disabled
To disable detection of all user-defined tones on the channel, set toneid to
TONEALL.
evt_mask specifies whether to disable detection of the user-defined tone going on or
going off. Set to one or both of the following using a bitwise-OR ( | ) operator.
• DM_TONEON – disable TONE ON detection
• DM_TONEOFF – disable TONE OFF detection
evt_mask affects the enabled/disabled status of the tone template and remains
in effect until dx_distone( ) or dx_enbtone( ) is called again to reset it.