dx_playf( )

Description | Example | Errors | See Also

Name:	int dx_playf(chdev,fnamep,tptp,mode)
Inputs:	int chdev	valid Dialogic channel device handle
	char *fnamep	pointer to name of file to play
	DV_TPT *tptp	pointer to Termination Parameter Table Structure
	unsigned short mode	playing mode bit mask for this play session
Returns:	0 if success
	-1 if failure
Includes:	srllib.h
	dxxxlib.h
Category:	Convenience

Description

dx_playf( ) is a convenience function that synchronously plays voice data or transfers ADSI data (using the ADSI protocol) from a single file.

NOTE:

Although this function can be used for transmitting ADSI data, the dx_RxIottData( ), dx_TxIottData( ), and dx_TxRxIottData( ) functions are recommended as the preferred method.

dx_playf( ) operates the same as synchronous dx_play( ) if the DX_IOTT structure specified a single file entry. dx_playf( ) is provided as a convenient way to play back data or transfer ADSI data from a single file without having to specify a DX_IOTT structure for only one file. The dx_playf( ) function opens and closes the file specified by fnamep while the dx_play( ) function uses a DX_IOTT structure that requires the application to open and close the file.

Parameter	Description
fnamep	points to the file from which voice data will be played.

For information about other function arguments and transferring ADSI data, see dx_play( ).

Example

#include <srllib.h>  
#include <dxxxlib.h>  
#include <windows.h>  
   
main()  
{  
   int chdev;  
   DV_TPT tpt[2];  
   
   /* Open the channel using dx_open( ). Get channel device descriptor in  
    * chdev.  
    */  
   if ((chdev = dx_open("dxxxB1C1",NULL)) == -1) {  
     /* process error */  
   }  
   
   /*  
    * Set up the DV_TPT structures for MAXDTMF. Play until one digit is  
    *  pressed or the file has completed play  
    */  
   dx_clrtpt(tpt,1);  
   tpt[0].tp_type   = IO_EOT;      /* only entry in the table */  
   tpt[0].tp_termno = DX_MAXDTMF;  /* Maximum digits */  
   tpt[0].tp_length = 1;           /* terminate on the first digit */  
   tpt[0].tp_flags  = TF_MAXDTMF;  /* Use the default flags */  
   
   if (dx_playf(chdev,"weather.vox",tpt,EV_SYNC) == -1) {  
     /* process error */  
   }  
   .  
   .  
}

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_BADIOTT	Invalid DX_IOTT entry
EDX_BADTPT	Invalid DX_TPT entry
EDX_BUSY	Busy executing I/O function
EDX_SYSTEM	Error from operating system; use dx_fileerrno( ) to obtain error value

See Also

Related Functions:

• dx_rec( )
• dx_recf( )
• dx_setparm( )
• dx_getparm( )

Setting Speed and Volume:

• dx_adjsv( )
• dx_setsvcond( )

Setting and Handling Play Termination:

• ATDX_TERMMSK( )
• DV_TPT

Click here to contact Dialogic Customer Engineering