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 59
Call Progress Analysis
TONE_DATA.numofseg
Specifies the number of segments for a multi-segment tone.
7.8.3 Rules for Modifying a Tone Definition on DM3 Boards
Consider the following rules and guidelines for modifying default tone definitions on DM3 boards
using the voice API library:
• Yo u m u s t i ss u e dx_querytone( ), dx_deletetone( ), and dx_createtone( ) in this order, one
tone at a time, for each tone definition to be modified.
• Attempting to create a new tone definition before deleting the current call progress tone will
result in an EDX_TNQUERYDELETE error.
• When dx_querytone( ), dx_deletetone( ), or dx_createtone( ) is issued in asynchronous
mode and is immediately followed by another similar call prior to completion of the previous
call on the same device, the subsequent call will fail with device busy.
• Only default call progress analysis tones and SIT sequences are supported for these three
functions. For a list of these tones, see Table 5, “Special Information Tone Sequences (DM3)”,
on page 54 and Table 6, “Default Call Progress Analysis Tone Definitions (DM3)”, on
page 57.
• These three voice API functions are provided to manipulate the call progress analysis tone
definitions. However, not all the functionality provided by these tones is available through the
voice API. You may need to use the Global Call API to access the functionality, for example,
in the case of dial tone detection and disconnect tone detection.
• If the application deletes all the default call progress analysis tones in a particular set (where a
set is defined as busy tones, dial tones, ringback tones, fax tones, disconnect tone, and special
information tones), the set itself is deleted from the board and call progress analysis cannot be
performed successfully. Therefore, you must have at least one tone defined in each tone set in
order for call progress analysis to perform successfully.
Note: The Learn Mode API and Tone Set File (TSF) API provide a more comprehensive way to manage
call progress tones, in particular the unique call progress tones produced by PBXs, key systems,
and PSTNs. Applications can learn tone characteristics using the Learn Mode API. Information on
several different tones forms one tone set. Tone sets can be written to a tone set file using the Tone
Set File API. For more information, see the Learn Mode and Tone Set File API Software Reference.
7.8.4 Rules for Using a Single Tone Proxy for a Dual Tone
A single tone proxy (also called a twin tone) acts as a proxy for a dual tone. A single tone proxy
can be defined when you run into difficulty detecting a dual tone. This situation can arise when the
two frequencies of the dual tone are close together, are very short tones, or are even multiples of
each other. In these cases, the dual tone might be detected as a single tone. A single tone proxy can
help improve the detection of the dual tone by providing an additional tone definition.
The TONE_SEG.tn_twinmin field defines the minimum frequency of the tone and
TONE_SEG.tn_twinmax field defines the maximum frequency of the tone.