dcb_getcde( )

Description | Cautions | Example | Errors | See Also

Name:	int dcb_getcde(devh,confid,cdt)
Inputs:	int devh	DCB/SC DSP device handle
	int confid	conference identifier
	MS_CDT *cdt	pointer to conference descriptor table element
Returns:	0 on success -1 on failure
Includes:	srllib.h dtilib.h msilib.h dcblib.h
Category:	Conference Management
Mode:	synchronous

Description

The dcb_getcde( ) function retrieves the attributes of a conferee in an existing conference.

Parameter	Description
devh:	The DCB/SC DSP device handle.
confid:	The conference identifier.
cdt:	Pointer to the conference descriptor table element.

This function requires that the conferee's chan_num and chan_sel be specified. On successful completion, the conference party's attribute will be returned in the char_attr field of the MS_CDT structure.

The conference descriptor table is an array of the MS_CDT structure. The MS_CDT structure has the following format:

typedef struct {  
          int chan_num;      /* time slot number */  
          int chan_sel;      /* meaning of time slot number */  
          int chan_attr;     /* attribute description */  
} MS_CDT;

The chan_num denotes the SCbus transmit time slot number of the device. The chan_sel defines the meaning of chan_num. At present, chan_sel should be set to the following value:

• MSPN_TS SCbus time slot number

Channel attribute is a bitmask describing the conferee's properties within the conference. Possible returns are listed in the table below. A combination of any of the attributes shown in the table may be returned.

Table 5. Possible Returns for Channel Attribute

Channel Attribute	Description
MSPA_NULL	No special attributes for conferee. The conferee hears everyone except the coach.
MSPA_RO	Conferee participates in the conference in receive-only mode.
MSPA_TARIFF	Conferee receives periodic tone for duration of call.
MSPA_COACH	Conferee is a coach. Coach is heard by pupil only.
MSPA_PUPIL	Conferee is a pupil. Pupil hears everyone including coach.

NOTE:

This function must be invoked multiple times if the attributes of more than one conferee are desired.

Cautions

This function fails when:

• The device handle specified is invalid.
• An invalid conference ID is specified.
• The queried conferee is not in the conference.

Example

#include <windows.h>  
#include <stdio.h>  
#include "srllib.h"  
#include "dtilib.h"  
#include "msilib.h"  
#include "dcblib.h"  
#include "errno.h"  
#define NUM_PARTIES     2  
main()  
{  
   int    dspdevh;            /* DCB/SC DSP device handle */  
   int    tsdevh1, tsdevh2;   /* DTI time slot device handles */  
   MS_CDT cdt[NUM_PARTIES];   /* Conference descriptor table */  
   int    confid;             /* Conference ID */  
   int    attrib;             /* Time slot attribute */  
   long   scts1, scts2;       /* SCbus time slots */  
   /* Open DCB/SC board 1, DSP 2 device */  
   if ((dspdevh = dcb_open("dcbB1D2",0)) == -1) {  
      printf("Cannot open dcbB1D2: errno = %d", errno);  
      exit(1);  
   }
  
   /* Open DTI board 1, time slot 1 */  
   if ((tsdevh1 = dt_open("dtiB1T1",0)) == -1) {  
      printf( "Cannot open dtiB1T1: errno = %d", errno);    
      exit(1);  
   }  
   /* Prepare the time slot information structure */  
   tsinfo.sc_numts = 1;  
   tsinfo.sc_tsarrayp = &scts1;  
   /* Retrieve the SCbus transmit time slot for tsdevh1 */  
   if (dt_getxmitslot(tsdevh1, &tsinfo) == -1){  
      printf("Error Message = %s", ATDV_ERRMSGP(tsdevh1));  
      exit(1);  
   }  
   /* Set up the CDT structure */  
   cdt[0].chan_num  = (int)scts1;        /* scts is the SCbus transmit time slot */  
   cdt[0].chan_sel  = MSPN_TS;          /* returned from dt_getxmitslot(). */  
   cdt[0].chan_attr = MSPA_TARIFF;      /* Conferee will receive periodic tariff tone */  
   /* Open DTI board 1, tslot 2 */  
   if ((tsdevh2 = dt_open("dtiB1T2",0)) == -1) {  
      printf( "Cannot open dtiB1T2: errno = %d", errno);    
      exit(1);  
   }  
   /* Prepare the time slot information structure */  
   tsinfo.sc_numts = 1;  
   tsinfo.sc_tsarrayp = &scts2;  
   if (dt_getxmitslot(tsdevh2, &tsinfo) == -1){  
      printf("Error Message = %s", ATDV_ERRMSGP(tsdevh2));  
      exit(1);  
   }  
   /* SCbus time slot to be conferenced */  
   cdt[1].chan_num  = (int)scts2;      /* scts is the SCbus transmit time slot */  
   cdt[1].chan_sel  = MSPN_TS;        /* returned from dt_getxmitslot(). */  
   cdt[1].chan_attr = MSPA_PUPIL;     /* The conferee may be coached later */  
   /* Establish the two party conference */  
   if (dcb_estconf(dspdevh, cdt, NUM_PARTIES, MSCA_ND, &confid) == -1){  
      printf("Error Message = %s", ATDV_ERRMSGP(dspdevh));  
      exit(1);  
   }  
   /* Do a listen to the conference signal for tsdevh1 */  
   tsinfo.sc_numts = 1;  
   tsinfo.sc_tsarrayp = &cdt[0].chan_lts;  
   if (dt_listen(tsdevh1,&tsinfo) == -1){  
      printf("Error Message = %s", ATDV_ERRMSGP(tsdevh1));  
      exit(1);  
   }
  
   /* Do a listen to the conference signal for tsdevh2 */  
   tsinfo.sc_numts = 1;  
   tsinfo.sc_tsarrayp = &cdt[1].chan_lts;  
   if (dt_listen(tsdevh2,&tsinfo) == -1){  
      printf("Error Message = %s", ATDV_ERRMSGP(tsdevh2));  
      exit(1);  
   }  
   /* Now get the attribute of conferee on tsdevh2 */  
   cdt[0].chan_num = (int)scts2;  
   cdt[0].chan_sel = MSPN_TS;  
   if(dcb_getcde(dspdevh, confid, &cdt)==-1){  
     printf("Error Message = %s", ATDV_ERRMSGP(dspdevh));  
     exit(1);  
   }  
   printf ("%s has conferee attribute 0x%x\n", ATDV_NAMEP(tsdevh2), cdt[0].chan_attr);  
   /* Finished with conference, so remove listens */  
   if (dt_unlisten(tsdevh1) == -1){  
      printf("Error Message = %s", ATDV_ERRMSGP(tsdevh1));  
      exit(1);  
   }  
   if (dt_unlisten(tsdevh2) == -1){  
      printf("Error Message = %s", ATDV_ERRMSGP(tsdevh2));  
      exit(1);  
   }  
   /* Delete the conference */  
   if(dcb_delconf(dspdevh, confid) == -1) {  
      printf("Cannot delete conference %d. Error Message = %s", confid,  
              ATDV_ERRMSGP(dspdevh));  
      exit(1);  
   }  
   /* And close all open devices */  
   if (dt_close(tsdevh1) == -1){  
      printf("Error (0x%x) closing tsdevh1\n", errno);  
      exit(1);  
   }  
   if (dt_close(tsdevh2) == -1){  
      printf("Error (0x%x) closing tsdevh2\n", errno);  
      exit(1);  
   }  
   if (dcb_close(dspdevh) == -1){  
      printf("Cannot close dcbB1D2 : errno = %d\n", errno);  
      exit(1);  
   }  
}

Errors

If the function does not complete successfully, it will return -1 to indicate an error. Use the Standard Attribute functions ATDV_LASTERR( ) to obtain the applicable error value, or ATDV_ERRMSGP( ) to obtain a more descriptive error message.

Refer to the error type tables found in Chapter 2 of this guide. Error defines can be found in dtilib.h, msilib.h or dcblib.h.

See Also

• dcb_setcde( )

Click here to contact Dialogic Customer Engineering