dx_bldstcad( )

Description | Example | Cautions | Errors | See Also

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 10ms
	unsigned int ontdev	on time deviation in 10ms
	unsigned int offtime	tone off time in 10ms
	unsigned int offtdev	off time deviation in 10ms
	unsigned int repcnt	repetitions if cadence
Returns:	0 if success
	-1 if failure
Includes:	srllib.h dxxxlib.h
Category:	Global Tone Detection

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 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.
freq	specifies the frequency (in Hz) for the tone
frqdev	specifies the allowable deviation for the frequency (in Hz).
ontime	specifies the length of time for which the cadence is on. (10 ms units)
ontdev	specifies the allowable deviation for on time in 10 ms units.
offtime	specifies the length of time for which the cadence is off. (10 ms units)
offtdev	specifies the allowable deviation for off time in 10 ms units.
repcnt	specifies the number of repetitions for the cadence (i.e., the number of times that an on/off signal is repeated).

Example

#include <stdio.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <windows.h>  
   
#define TID_4   104  
   
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 Single Tone Frequency Tone of 950-1050 Hz.  
    * On between 190-210 msecs and off 990-1010 msecs and  
    * a cadence of 3.  
    */  
   if ( dx_bldstcad( TID_4, 1000, 50, 20, 1, 100, 1, 3 ) == -1 ) {  
      printf( "Unable to build a Single 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 );  
}

Cautions

1. Only 1 tone per application may be defined at any time. dx_bldstcad( ) 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 IDs 101 to 115 for the R2MF tones. See the r2_creatfsig( ) function 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.

Errors

None.

See Also

Global Tone Detection:

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

Building Tones:

• dx_blddtcad( )
• dx_blddt( )
• dx_bldst( )

Enabling Tone Detection:

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

R2MF Tones:

• r2_creatfsig( )
• r2_playbsig( )

Click here to contact Dialogic Customer Engineering