• 4.3.1. Voice API Function Restrictions
• 4.3.2. Speed and Volume Control Restrictions
• 4.3.3. DV_TPT Termination Parameter Table Restrictions
• 4.3.4. Device Parameter Restrictions

4.3. Voice API Function and Parameter Restrictions

R4 for DM3 supports all voice API functions except those noted in Table 4. List of Voice API Functions Restricted and Not Supported. See the Voice Software Reference for detailed information about each function.

Restrictions are described in the following areas:

• Restricted Voice Functions: Functions not supported and only partially supported (includes parameters not supported).
• Speed and Volume Control: Functions and parameters not supported and only partially supported.
• Termination Conditions: Parameters not supported and parameters fully supported.
• Board and Channel Device Parameters: Parameters not supported and parameters fully supported.

Errors: A voice function that is not supported or is only partially supported (that is, does not support all its parameters) by DM3 boards will return the following error codes:

• If you execute a standard voice function that is not supported by DM3 boards, it produces an EDX_NOTIMP ("not implemented") error.
• If you execute a supported voice function with a parameter that is not supported on DM3 boards, it produces an EDX_NOSUPPORT error.

NOTE:

Some voice API functions may produce different voice API errors in R4 for DM3 than in R4. Use the standard error functions ATDV_LASTERR( ) and ATDV_ERRMSGP( ) to handle the errors.

4.3.1. Voice API Function Restrictions

The following list shows functions that are not supported on DM3 devices as well as those functions that are partially supported. For those functions partially supported, the nature of the limitation is noted, or else a reference is given to the location of additional details.

Table 4. List of Voice API Functions Restricted and Not Supported

Function Name	Notes
ag_getctinfo( )	Not supported. (This function is in the SCbus Routing Software Reference.)
ag_getxmitslot( )	Not supported. (This function is in the SCbus Routing Software Reference.)
ag_listen( )	Not supported. (This function is in the SCbus Routing Software Reference.)
ag_unlisten( )	Not supported. (This function is in the SCbus Routing Software Reference.)
ATDX_ANSRSIZ( )	Not supported.
ATDX_BUFDIGS( )	Not supported
ATDX_CRTNID( )	Not supported.
ATDX_DTNFAIL( )	Not supported.
ATDX_EVTCNT( )	Not supported.
ATDX_FRQDUR( )	Not supported.
ATDX_FRQDUR2( )	Not supported.
ATDX_FRQDUR3( )	Not supported.
ATDX_FRQHZ( )	Not supported.
ATDX_FRQHZ2( )	Not supported.
ATDX_FRQHZ3( )	Not supported.
ATDX_FRQOUT( )	Not supported.
ATDX_FWVER( )	Not supported.
ATDX_HOOKST( )	Not supported.
ATDX_LINEST( )	Not supported.
ATDX_LONGLOW( )	Not supported.
ATDX_PHYADDR( )	Not supported.
ATDX_RINGCNT( )	Not supported.
ATDX_SHORTLOW( )	Not supported.
ATDX_SIZEHI( )	Not supported.
dx_addspddig( )	Limitations: See Section 4.3.2. Speed and Volume Control Restrictions.
dx_addtone( )	Limitations: The arguments digit and digtype are not supported for R4 on DM3. Therefore, mapping custom-defined GTD tones to digits (DG_USER1 to DG_USERn) is not supported
dx_addvoldig( )	Limitations: See Section 4.3.2. Speed and Volume Control Restrictions.
dx_chgdur( )	Not supported.
dx_chgfreq( )	Not supported.
dx_chgrepcnt( )	Not supported.
dx_dial( )	Limitations: See Section 4.6. Voice API Call Progress Analysis Support.
dx_dialtpt( )	Not supported.
dx_getdig( )	Limitations: Global DPD is not supported (DG_DPD_ASCII is not available).
dx_getdigEx( )	Not supported.
dx_getfeaturelist( )	See Section 2.3.5. Determining Channel Capabilities in Flexible Routing Configurations for information on using this function to identify device capabilities.
dx_getparm( )	Limitations: See Section 4.3.4. Device Parameter Restrictions.
dx_GetRscStatus( )	Not supported.
dx_getxmitslotecr( )	Not supported.
dx_gtcallid( )	Not supported.
dx_gtextcallid( )	Not supported.
dx_initcallp( )	Not supported.
dx_InitializeBargeIn( )	Not supported.
dx_listenecr( )	Not supported.
dx_listenecrex( )	Not supported.
dx_mreciottdata( )	Limitations: See Sections 4.1.5. Play/Record Limitations and Features Not Supported and 4.1.6. Running Transaction Record. This function is not supported on DI nor HDSI products, because DI and HDSI products do not support routable voice resources.
dx_play( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported and Section 4.3.3. DV_TPT Termination Parameter Table Restrictions. The following modes are not supported:   PM_ADSIALERT   PM_ADSI
dx_playf( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported.
dx_playiottdata( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported.
dx_playtoneEx( )	Limitations: The Cadenced Tone Generation TN_GENCAD cycles parm is limited to 40 cycles instead of the documented 255 maximum; any number of cycles greater than 40 is limited to 40.
dx_playvox( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported.
dx_playwav( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported.
dx_rec( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported.
dx_recf( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported.
dx_recm( )	Not supported. Use dx_mreciottdata( ).
dx_recmf( )	Not supported. Use dx_mreciottdata( ).
dx_reciottdata( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported. This function is supported on HDSI products, provided that the correct play/record PCD file is downloaded.
dx_recvox( )	Limitations: See Section 4.1.5. Play/Record Limitations and Features Not Supported.
dx_recwav( )	Limitations: See Section4.1.5. Play/Record Limitations and Features Not Supported.
dx_sendevt( )	Not supported.
dx_setdigbuf( )	Not supported.
dx_setdigtyp( )	Not supported.
dx_setevtmsk( )	Limitations: Ring detection and Loop Current on/off detection are not supported (DM_RINGS, DM_RNGOFF, DM_LCOFF, DM_LCON, DM_LCREV produces an EDX_NOSUPPORT error).
dx_sethook( )	Not supported.
dx_setparm( )	Limitations: See Section 4.3.4. Device Parameter Restrictions.
dx_setsvcond( )	Limitations: See Section 4.3.2. Speed and Volume Control Restrictions.
dx_settone( )	Not supported.
dx_settonelen( )	Not supported.
dx_TSFStatus( )	Not supported.
dx_unlistenecr( )	Not supported.
dx_wink( )	Not supported.
dx_wtcallid( )	Not supported.
dx_wtring( )	Not supported.
li_attendant( )	Not supported.
li_islicensed_syntellect( )	Not supported.
r2_creatfsig( )	Not supported.
r2_playbsig( )	Not supported.

NOTE:

dx_ functions are not supported on the IP media devices of IPLink boards. See the IP Media Users Guide for information on media control of the IP component.

4.3.2. Speed and Volume Control Restrictions

The following Speed and Volume Control functions are fully supported:

• dx_adjsv( )
• dx_clrsvcond( )
• dx_getcursv( )
• dx_getsvmt( )
• dx_setsvmt( )

The following Speed and Volume Control functions are partially supported as described in the restrictions that follow:

• dx_addspddig( )
• dx_addvoldig( )
• dx_setsvcond( )

The following restrictions apply to Speed and Volume Control:

• Speed Control is partially supported and has the following limitation: Speed Control is supported only at the 8 kHz sampling rate using the PCM voice coder with A-law or _-law coding, or the OKI ADPCM voice coder.
• Speed Control and Volume Control adjustments are supported by the dx_setsvcond( ) function with the following limitation:

NOTE:

For action SV_TOGGLE, an adjsize of SV_CURLASTMOD or SV_RESETORIG is not supported. The adjsize values of SV_CURORIGIN and SV_TOGORIGIN are supported. SV_CURORIGIN sets the current speed or volume level to the origin, and SV_TOGORIGIN toggles between the origin and the last modified speed or volume level.Digits that are used for play adjustment may also be used as a terminating condition. If a digit is defined as both, then both actions are applied upon detection of that digit.

• Speed Control and Volume Control adjustments are supported by the dx_addspddig( ) and dx_addvoldig( ) functions with the following limitations:
  • For dx_addspddig( ), the adjval values of SV_ADD10PCT, SV_SUB10PCT, and SV_NORMAL are supported. These values increase play speed by 10%, decrease play speed by 10%, and set play speed to normal.
  • For dx_addvoldig( ), the adjval values of SV_ADD2DB, SV_SUB2DB, and SV_NORMAL are supported. These values increase play volume by 2 dB, decrease play volume by 2 dB, and set play volume to normal.

4.3.3. DV_TPT Termination Parameter Table Restrictions

Those voice termination conditions that are supported by the DV_TPT Termination Parameter Table are described below, along with those conditions that are not supported.

Table 5. Termination Conditions Not Supported shows the voice termination conditions that are not supported by the DV_TPT Termination Parameter Table (tp_termno field).

Table 5. Termination Conditions Not Supported

Termination Condition	Description
DX_LCOFF	Loop current drop
DX_PMOFF	Pattern of non-silence
DX_PMON	Pattern of silence

Table 6. Termination Conditions Supported shows a summary of the voice termination conditions that are supported by the DV_TPT Termination Parameter Table (tp_termno field).

Table 6. Termination Conditions Supported

Termination Condition	Default Sensitivity	Description
DX_DIGTYPE	Level	Digit for standard DTMF
DX_MAXNOSIL	Edge	Maximum length of non-silence (see restrictions below)
DX_MAXSIL	Edge	Maximum length of silence (see restrictions below)
DX_MAXDTMF	Level	Maximum number of digits received
DX_IDDTIME	Edge	Maximum delay between digits
DX_MAXTIME	Edge	Maximum function time
DX_DIGMASK	Level	Specific digit received
DX_TONE	Level	Tone On/Off for user-defined GTD tone

The supported termination conditions have the following qualifications:

• DX_DIGTYPE is supported with the limitation that the ASCII value set in the tp_value field must match a real DTMF tone (0-9, a-d, *, #).
• For DX_MAXNOSIL and DX_MAXSIL termination conditions, the maximum length of time specified is restricted as follows:
  • The range of time that may be used is limited to a minimum of 1 second and a maximum of 30 seconds.
  • The settings within this time range are limited to the following step values: 1, 2, 3, 5, 8, 10, 15, and 30 seconds.
  • If you specify a time less than 1 second, the function will fail with a EDX_BADTPT error.
  • If you specify a time greater than 30 seconds, it will function as if you specified 30 seconds.
  • If you specify any time between 1 and 30 seconds, it will function as if you specified the next lowest step value in the range (it is rounded down). For example, if you set DX_MAXSIL to terminate on 4.9 seconds of silence, it will terminate on three seconds of silence rather than five seconds, because three seconds is the next lowest step value.
• The default sensitivity shown in Table 6 is given for DM3 boards.
• Parameters for tp_flags:
  • For DX_IDDTIME, tp_flags TF_FIRST can be used for initial interdigit delay termination.
  • TF_10MS can be used for 10 millisecond timing.
  • The TF_LEVEL, TF_EDGE, and TF_CLREND tp_flags have no effect and will be ignored.
  • The TF_SETINIT flag is not supported.

4.3.4. Device Parameter Restrictions

Those board and channel device parameters that are supported by the dx_getparm( ) and dx_setparm( ) functions are described here, along with those parameters that are not supported.

Table 7. Voice Board and Channel Parameters Supported shows the board and channel device parameters that are supported.

Table 7. Voice Board and Channel Parameters Supported

Define	Read/ Write	Description
Board Parameters:
DXBD_CHNUM	R	Channel Number - Returns the number of voice channels on the board.
DXBD_HWTYPE	R	Hardware Type - For DM3 boards, always returns TYP_D41.
DXBD_SYSCFG	R	System Configuration - For DM3 boards, always returns 1 to indicate a digital network interface.
Channel Parameters:
DXCH_PLAYDRATE	R/W	Play Digitization Rate. Valid parameter values are: 6000 - 6 kHz sampling rate 8000 - 8 kHz sampling rate
DXCH_RECRDRATE	R/W	Record Digitization Rate. Valid values are: 6000 - 6 kHz sampling rate 8000 - 8 kHz sampling rate
DXCH_SCRFEATURE	R/W	Silence Compression Record (SCR) DXCH_SCRDISABLED DXCH_SCRENABLED
DXCH_XFERBUFSIZE	R	Transfer Buffer Size - Returns the bulk queue buffer size as set by the dx_setchxfercnt( ) function.

Table 8. Voice Board and Channel Parameters Not Supported shows the board and channel device parameters that are not supported.

Table 8. Voice Board and Channel Parameters Not Supported

Define	Read/ Write	Description
Board Parameters:
DXBD_FLASHCHR	R/W	Flash character
DXBD_FLASHTM	R/W	Flash Time
DXBD_MAXPDOFF	R/W	Maximum Pulse Digit Off
DXBD_MAXSLOFF	R/W	Maximum Silence Off
DXBD_MFDELAY	R/W	MF Interdigit Delay
DXBD_MFLKPTONE	R/W	MF Length of LKP Tone
DXBD_MFMINON	R/W	Minimum MF On
DXBD_MFTONE	R/W	MF Minimum Tone Duration
DXBD_MINIPD	R/W	Minimum Loop Interpulse Detection
DXBD_MINISL	R/W	Minimum Interdigit Silence
DXBD_MINLCOFF	R/W	Minimum Loop Current Off
DXBD_MINOFFHKTM	R/W	Minimum offhook time
DXBD_MINPDOFF	R/W	Minimum Pulse Detection Off
DXBD_MINPDON	R/W	Minimum Pulse Detection On
DXBD_MINSLOFF	R/W	Minimum Silence Off
DXBD_MINSLON	R/W	Minimum Silence On
DXBD_MINTIOFF	R/W	Minimum DTI Off
DXBD_MINTION	R/W	Minimum DTI On
DXBD_OFFHDLY	R/W	Offhook Delay
DXBD_P_BK	R/W	Pulse Dial Break
DXBD_P_IDD	R/W	Pulse Interdigit Delay
DXBD_P_MK	R/W	Pulse Dial Make
DXBD_PAUSETM	R/W	Pause Time
DXBD_R_EDGE	R/W	Ring Edge
DXBD_R_IRD	R/W	Inter-ring Delay
DXBD_R_OFF	R/W	Ring-off Interval
DXBD_R_ON	R/W	Ring-on Interval
DXBD_S_BNC	R/W	Silence and Non-silence Debounce
DXBD_T_IDD	R/W	DTMF Interdigit delay
DXBD_TTDATA	R/W	DTMF length (duration) for dialing.

Define	Read/ Write	Description
Channel Parameters:
DXCH_AUDIOLINEIN	R/W	Audio Line In
DXCH_CALLID	R/W	Caller ID
DXCH_DFLAGS	R/W	DTMF detection edge select
DXCH_DTINITSET	R/W	DTMF Initiation
DXCH_DTMFDEB	R/W	DTMF debounce time
DXCH_DTMFTLK	R/W	Minimum DTMF Time
DXCH_MAXRWINK	R/W	Maximum Loop Current for Wink
DXCH_MFMODE	R/W	Minimum MF KP Time
DXCH_MINRWINK	R/W	Minimum Loop Current for Wink
DXCH_RINGCNT	R/W	Ring Number
DXCH_RXDATABUFSIZE	R/W	Library Buffer Size for Receiving Data
DXCH_T_IDD	R/W	DTMF Interdigit delay
DXCH_TTDATA	R/W	DTMF length (duration) for dialing.
DXCH_WINKDLY	R/W	Wink Delay
DXCH_WINKLEN	R/W	Wink Length

Click here to contact Dialogic Customer Engineering