dx_bldst( )

Description | Cautions | Example | Errors | See Also

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:

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 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).
mode	specifies whether detection is on the leading or trailing edge of the tone. Set to one of the following:
	TN_LEADING
	TN_TRAILING

Cautions

1. Only 1 tone per application may be defined at any time. dx_bldst( ) 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 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_3   103  
   
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 Simple Single Tone Frequency Tone of  
    * 950-1050 Hz using trailing edge detection.  
    */  
   if ( dx_bldst( TID_3, 1000, 50, TN_TRAILING ) == -1 ) {  
      printf( "Unable to build a Single Tone 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_blddtcad( )
• 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