User's Manual
Table Of Contents
- Contents
- Figures
- Tables
- Revision History
- About This Publication
- 1. Product Description
- 2. Programming Models
- 3. Device Handling
- 4. Event Handling
- 5. Error Handling
- 6. Application Development Guidelines
- 7. Call Progress Analysis
- 7.1 Call Progress Analysis Overview
- 7.2 Call Progress and Call Analysis Terminology
- 7.3 Call Progress Analysis Components
- 7.4 Using Call Progress Analysis on DM3 Boards
- 7.5 Call Progress Analysis Tone Detection on DM3 Boards
- 7.6 Media Tone Detection on DM3 Boards
- 7.7 Default Call Progress Analysis Tone Definitions on DM3 Boards
- 7.8 Modifying Default Call Progress Analysis Tone Definitions on DM3 Boards
- 7.9 Call Progress Analysis Errors
- 7.10 Using Call Progress Analysis on Springware Boards
- 7.11 Call Progress Analysis Tone Detection on Springware Boards
- 7.12 Media Tone Detection on Springware Boards
- 7.13 Default Call Progress Analysis Tone Definitions on Springware Boards
- 7.14 Modifying Default Call Progress Analysis Tone Definitions on Springware Boards
- 7.15 SIT Frequency Detection (Springware Only)
- 7.15.1 Tri-Tone SIT Sequences
- 7.15.2 Setting Tri-Tone SIT Frequency Detection Parameters
- 7.15.3 Obtaining Tri-Tone SIT Frequency Information
- 7.15.4 Global Tone Detection Tone Memory Usage
- 7.15.5 Frequency Detection Errors
- 7.15.6 Setting Single Tone Frequency Detection Parameters
- 7.15.7 Obtaining Single Tone Frequency Information
- 7.16 Cadence Detection in Basic Call Progress Analysis (Springware Only)
- 8. Recording and Playback
- 8.1 Overview of Recording and Playback
- 8.2 Digital Recording and Playback
- 8.3 Play and Record Functions
- 8.4 Play and Record Convenience Functions
- 8.5 Voice Encoding Methods
- 8.6 G.726 Voice Coder
- 8.7 Transaction Record
- 8.8 Silence Compressed Record
- 8.9 Recording with the Voice Activity Detector
- 8.10 Streaming to Board
- 8.11 Pause and Resume Play
- 8.12 Echo Cancellation Resource
- 9. Speed and Volume Control
- 10. Send and Receive FSK Data
- 11. Caller ID
- 12. Cached Prompt Management
- 13. Global Tone Detection and Generation, and Cadenced Tone Generation
- 13.1 Global Tone Detection (GTD)
- 13.1.1 Overview of Global Tone Detection
- 13.1.2 Global Tone Detection on DM3 Boards versus Springware Boards
- 13.1.3 Defining Global Tone Detection Tones
- 13.1.4 Building Tone Templates
- 13.1.5 Working with Tone Templates
- 13.1.6 Retrieving Tone Events
- 13.1.7 Setting GTD Tones as Termination Conditions
- 13.1.8 Maximum Amount of Memory for Tone Templates
- 13.1.9 Estimating Memory
- 13.1.10 Guidelines for Creating User-Defined Tones
- 13.1.11 Global Tone Detection Application
- 13.2 Global Tone Generation (GTG)
- 13.3 Cadenced Tone Generation
- 13.3.1 Using Cadenced Tone Generation
- 13.3.2 How To Generate a Custom Cadenced Tone
- 13.3.3 How To Generate a Non-Cadenced Tone
- 13.3.4 TN_GENCAD Data Structure - Cadenced Tone Generation
- 13.3.5 How To Generate a Standard PBX Call Progress Signal
- 13.3.6 Predefined Set of Standard PBX Call Progress Signals
- 13.3.7 Important Considerations for Using Predefined Call Progress Signals
- 13.1 Global Tone Detection (GTD)
- 14. Global Dial Pulse Detection
- 14.1 Key Features
- 14.2 Global DPD Parameters
- 14.3 Enabling Global DPD
- 14.4 Global DPD Programming Considerations
- 14.5 Retrieving Digits from the Digit Buffer
- 14.6 Retrieving Digits as Events
- 14.7 Dial Pulse Detection Digit Type Reporting
- 14.8 Defines for Digit Type Reporting
- 14.9 Global DPD Programming Procedure
- 14.10 Global DPD Example Code
- 15. R2/MF Signaling
- 16. Syntellect License Automated Attendant
- 17. Building Applications
- Glossary
- Index

Voice API Programming Guide — June 2005 171
Global Dial Pulse Detection
Global DPD must be implemented on a call-by-call basis. Global DPD uses the dx_setdigtyp( )
function to enable DPD. See the Voice API Library Reference for information on all functions and
data structures described in this chapter.
For any digit detected, you can determine the digit type such as DTMF or DPD by using the
DV_DIGIT data structure in the application. When a dx_getdig( ) or dx_getdigEx( ) function call
is performed, the digits are collected from the firmware and transferred to the user’s digit buffer.
The digits are stored as an array inside the DV_DIGIT structure.
You then use a pointer to the structure that contains a digit buffer. For an example, see
Section 14.10, “Global DPD Example Code”, on page 173. This method allows you to determine
very quickly whether a pulse or DTMF telephone is being used.
14.4 Global DPD Programming Considerations
The global DPD algorithm will accurately detect digits in the supported regions without requesting
a special training digit from the caller or requiring any other restrictions on the application.
However, observe the following considerations when designing the application:
• Talk-off rejection (the ability of the algorithm to distinguish between dial pulses and the
human voice) will improve after the first digit is detected.
• Digit detection will be slightly more accurate (about 2%) after detecting a digit of 5 or greater.
It is not necessary to dial a special training digit to do this. The application may simply restrict
the first menu to digits 5, 6, 7, 8, 9, and 0, and the training will be complete. Subsequent menus
may be unrestricted.
• In general, detection accuracy is greater for higher digits than for lower. While detection
accuracy is very high, it may be further improved by restricting menu selections, whenever
convenient, to digits greater than 3.
14.5 Retrieving Digits from the Digit Buffer
To get the digits from the digit buffer, use the following synchronous programming model:
1. Define a data structure of type DV_DIGIT (the DV_DIGIT structure is defined by including
the dxxxlib.h header file).
2. Enable DPD on the desired channels using the dx_setdigtyp( ) function.
3. For each new connection, use dx_setdigtyp( ) with the D_DPDZ mask, which initializes the
DPD algorithm. After collecting the first DPD digit string, the mask can be set to D_DPD for
the remainder of that connection. Each subsequent invocation of dx_setdigtyp( ) must use the
D_DPD mask.
4. Execute the dx_getdig( ) function to collect and transfer the digits to the user’s digit buffer.
The digits are stored in the dg_value field of the DV_DIGIT structure. The corresponding digit
types (dial pulse, DTMF, and so on) are stored in the dg_type field of the DV_DIGIT structure.
For more information, see the DV_DIGIT structure in the Voice API Library Reference.