Intel 05-1832-002 User Manual

124

add a user-defined tone

!

!

!

! Description

The dx_addtone( ) function adds a user-defined tone that was defined by the most recent 

 (or other global tone detection build-tone) function call, to the specified channel. 

Adding a user-defined tone to a channel downloads it to the board and enables detection of tone-on 
and tone-off events for that tone by default.

Use 

 to disable detection of the tone, without removing the tone from the channel. 

Detection can be enabled again using 

. For example, if you only want to be notified 

of tone-on events, you should call dx_distone( ) to disable detection of tone-off events.

For more information on user-defined tones and global tone detection (GTD), see the Voice API 
Programming Guide.

int dx_addtone(chdev, digit, digtype)

int chdev

valid channel device handle

unsigned char digit

optional digit associated with the bound tone

unsigned char digtype

digit type

0 if success
-1 if failure

srllib.h
dxxxlib.h

Global Tone Detection

synchronous 

DM3, Springware

chdev 

specifies the valid channel device handle obtained when the channel was 
opened using 

digit 

specifies an optional digit to associate with the tone. When the tone is 
detected, the digit will be placed in the 

 digit buffer. These digits 

can be retrieved using 

 (they can be used in the same way as 

DTMF digits, for example).

If you do not specify a digit, the tone will be indicated by a DE_TONEON 
event or DE_TONEOFF event.