r2_creatfsig( )

Description | Cautions | Example | Errors | See Also

Name:	int r2_creatfsig(chdev,forwardsig)
Inputs:	int chdev	channel device handle
	int forwardsig	group I/II forward signal
Returns:	0 if success
	-1 if failure
Includes:	srllib.h
	dxxxlib.h
Category:	R2MF Convenience

Description

r2_creatfsig( ) is a convenience function that defines and enables leading edge detection of an R2MF forward signal on a channel.

NOTE:

This function calls the dx_blddt( ) function to create the template.

User-defined tone IDs 101 through 115 are used by this function.

For detailed information about R2MF signaling see the Voice Software Reference: Voice Features Guide.

Parameter	Description
chdev	specifies the valid channel device handle obtained when the channel was opened using dx_open( ).
forwardsig	specifies the name of a Group I or Group II forward signal which provides the tone ID for detection of the associated R2MF tone (or tones). Set to R2_ALLSIG to enable detection of all 15 tones or set to one of the following defines: Specify one of: Associated Tone ID Group I Group II SIGI_1 SIGII_1 101 SIGI_2 SIGII_2 102 SIGI_3 SIGII_3 103 SIGI_4 SIGII_4 104 SIGI_5 SIGII_5 105 SIGI_6 SIGII_6 106 SIGI_7 SIGII_7 107 SIGI_8 SIGII_8 108 SIGI_9 SIGII_9 109 SIGI_10 SIGII_10 110 SIGI_11 SIGII_11 111 SIGI_12 SIGII_12 112 SIGI_13 SIGII_13 113 SIGI_14 SIGII_14 114 SIGI_15 SIGII_15 115
NOTE: Either the Group I or the Group II define can be used to specify the forward signal, because the Group I and Group II defines correspond to the same set of 15 forward signals, and the same user-defined tones are used for Group I and Group II.

Cautions

1. The channel must be idle when calling this function.
2. Prior to creating the R2MF tones on a channel, you should delete any previously created user-defined tones (including non-R2MF tones) to avoid getting an error for having too many tones enabled on a channel.
3. This function creates R2MF tones with user-defined tone IDs from 101 to 115, and you should reserve these tone IDs for R2MF. If you attempt to create a forward signal tone with this function and you previously created a tone with the same tone ID, an invalid tone ID error will occur.
4. Maximum number of user-defined tones is on a per board basis.

Example

#include <stdio.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <windows.h>  
   
main()  
{  
   int  dxxxdev;  
   
   /*  
    * Open the Voice Channel Device and Enable a Handler  
    */  
   if ( ( dxxxdev = dx_open( "dxxxB1C1", NULL) ) == -1 ) {  
      perror( "dxxxB1C1" );  
      exit( 1 );  
   }  
   
   /*  
    * Create all forward signals  
    */  
   if ( r2_creatfsig( dxxxdev, R2_ALLFSIG ) == -1 ) {  
      printf( "Unable to Create the Forward Signals\n" );  
      printf( "Lasterror = %d  Err Msg = %s\n",  
          ATDV_LASTERR( dxxxdev ), ATDV_ERRMSGP( dxxxdev ) );  
      dx_close( dxxxdev );  
      exit( 1 );  
   }  
   
   /*  
    * Continue Processing  
    *   .  
    *   .  
    *   .  
    */  
   
   /*  
    * Close the opened Voice Channel Device  
    */  
   if ( dx_close( dxxxdev ) != 0 ) {  
      perror( "close" );  
   }  
   
   /* Terminate the Program */  
   exit( 0 );  
}

Errors

If this function returns -1 to indicate failure, use ATDV_LASTERR( ) and ATDV_ERRMSGP( ) to retrieve one of the following error reasons:

EDX_BADPARM	Invalid parameter
EDX_BADPROD	Function not supported on this board
EDX_SYSTEM	Error from operating system; use dx_fileerrno( ) to obtain error value
EDX_TONEID	Invalid tone template ID
EDX_MAXTMPLT	Maximum number of user-defined tones for the board
EDX_INVSUBCMD	Invalid sub-command
EDX_FREQDET	Invalid tone frequency
EDX_CADENCE	Invalid cadence component value
EDX_ASCII	Invalid ASCII value in tone template description
EDX_DIGTYPE	Invalid Dig_Type value in tone template description

See Also

• r2_playbsig( )
• dx_addtone( )
• dx_blddt( )
• R2MF Signaling - (Voice Software Reference: Voice Features Guide)

Click here to contact Dialogic Customer Engineering