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 53
Call Progress Analysis
To enable ringback detection, turn on SIT frequency detection in the DX_CAP ca_intflg field. For
details, see Section 7.4.3, “Setting Up Call Progress Analysis Parameters in DX_CAP”, on
page 48.
The following DX_CAP fields govern ringback behavior on DM3 boards:
ca_cnosig
Continuous No Signal: the maximum length of silence (no signal) allowed immediately after
the ca_stdely period (in 10 msec units). If this duration is exceeded, call progress analysis is
terminated with the reason CR_NORB (no ringback detected). Default value: 4000 (40
seconds).
ca_noanswer
No Answer: the length of time to wait after the first ringback before deciding that the call is
not answered (in 10 msec units). If this duration is exceeded, call progress analysis is
terminated with the reason CR_NOANS (no answer). Default value: 3000 (30 seconds).
7.5.4 Busy Tone Detection
Call progress analysis specifies two busy tones: TID_BUSY1 and TID_BUSY2. If either of them is
detected while frequency detection and cadence detection are active, then call progress is
terminated with the reason CR_BUSY. ATDX_CRTNID( ) identifies which busy tone was
detected.
To enable busy tone detection, turn on SIT frequency detection in the DX_CAP ca_intflg field. For
details, see Section 7.4.3, “Setting Up Call Progress Analysis Parameters in DX_CAP”, on
page 48.
7.5.5 Fax or Modem Tone Detection
Call progress analysis specifies two tones: TID_FAX1 and TID_FAX2. If either of these tones is
detected while frequency detection and cadence detection are active, then call progress is
terminated with the reason CR_FAXTONE. ATDX_CRTNID( ) identifies which fax or modem
tone was detected.
To enable fax or modem tone detection, use the ca_intflg field of the DX_CAP structure. For
details, see Section 7.4.3, “Setting Up Call Progress Analysis Parameters in DX_CAP”, on
page 48.
7.5.6 SIT Frequency Detection
Special Information Tone (SIT) frequency detection is a component of call progress analysis. On
DM3 boards, SIT sequences are defined as standard tone IDs.
To enable SIT frequency detection, use the ca_intflg field of the DX_CAP structure. For more
information, see Section 7.4.3, “Setting Up Call Progress Analysis Parameters in DX_CAP”, on
page 48.