dx_blddtcad( )

Description | Cautions | Example | Errors | See Also

Name:	int dx_blddtcad(tid,freq1,fq1dev,freq2,fq2dev,ontime, ontdev,offtime,offtdev,repcnt)
Inputs:	unsigned int tid	tone ID to assign.
	unsigned int freq1	frequency 1 in Hz
	unsigned int fq1dev	frequency 1 deviation in Hz
	unsigned int freq2	frequency 2 in Hz
	unsigned int fq2dev	frequency 2 deviation in Hz
	unsigned int ontime	tone-on time in 10ms
	unsigned int ontdev	tone-on time deviation in 10ms
	unsigned int offtime	tone-off time in 10ms
	unsigned int offtdev	tone-off time deviation in 10ms
	unsigned int repcnt	number of repetitions if cadence
Returns:	0 if success
	-1 if failure
Includes:	srllib.h dxxxlib.h
Category:	Global Tone Detection

Description

The dx_blddtcad( ) function defines a user-defined dual frequency cadenced tone. Subsequent calls to dx_addtone( ) will use this tone, until another tone is defined.

A dual frequency cadence tone has dual frequency signals with specific on/off characteristics.

Issuing a dx_blddtcad( ) defines a new tone but dx_addtone( ) must be used to add the tone to the channel.

Use dx_addtone( ) to enable detection of the user-defined tone on a channel.

Parameter	Description
tid	specifies a unique identifier for the tone.
	NOTE: Do not use tone IDs 261, 262 and 263, they are reserved for library use. If you are using R2MF tone detection, reserve the use of tone IDs 101 to 115 for the R2MF tones. See r2_creatfsig( ) for further information.
freq1	specifies the first frequency (in Hz) for the tone
frq1dev	specifies the allowable deviation for the first frequency (in Hz).
freq2	specifies the second frequency (in Hz) for the tone
frq2dev	specifies the allowable deviation for the second frequency (in Hz).
ontime	specifies the length of time for which the cadence is on (in 10ms units)
ontdev	specifies the allowable deviation for on time. (in 10ms units)
offtime	specifies the length of time for which the cadence is off (in 10ms units)
offtdev	specifies the allowable deviation for off time (in 10ms units).
repcnt	specifies the number of repetitions for the cadence (i.e. the number of times that an on/off signal is repeated).

Cautions

1. Only 1 user-defined tone per process can be defined at any time. dx_blddtcad( ) will replace the previous user-defined tone definition.
2. Do not use tone IDs 261, 262 and 263, they are reserved for library use.
3. If you are using R2MF tone detection, reserve the use of tone ID's 101 to 115 for the R2MF tones. See r2_creatfsig( ) for further information.
4. 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.

Example

#include <stdio.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <windows.h>  
   
#define TID_2   102  
   
main()  
{  
   int  dxxxdev;  
   
   /*  
    * Open the Voice Channel Device and Enable a Handler  
    */  
   if ( ( dxxxdev = dx_open( "dxxxB1C1", NULL) ) == -1 ) {  
      perror( "dxxxB1C1" );  
      exit( 1 );  
   }  
   
   /*  
    * Describe a Dual Tone Frequency Tone of 950-1050 Hz  
    * and 475-525 Hz. On between 190-210 msecs and off  
    * 990-1010 msecs and a cadence of 3.  
    */  
   if ( dx_blddtcad( TID_2, 1000, 50, 500, 25, 20, 1,  
                100, 1, 3 ) == -1 ) {  
      printf( "Unable to build a Dual Tone Cadence" );  
      printf( " Template\n");  
   }  
   
   /*  
    * Continue Processing  
    *   .  
    *   .  
    */  
   
   /*  
    * Close the opened Voice Channel Device  
    */  
   if ( dx_close( dxxxdev ) != 0 ) {  
      perror( "close" );  
   }  
   
   /* Terminate the Program */  
   exit( 0 );  
}

Errors

None.

See Also

Global Tone Detection:

• Global Tone Detection (Voice Software Reference: Voice Features Guide)

Building Tones:

• dx_bldst( )
• dx_blddt( )
• dx_bldstcad( )

Enabling Tone Detection:

• dx_addtone( )
• dx_distone( )
• dx_enbtone( )

R2MF Tones:

• r2_creatfsig( )
• r2_playbsig( )

Click here to contact Dialogic Customer Engineering