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 575
G.726: An international standard for encoding 8 kHz sampled audio signals for transmission over 16, 24, 32 and
40 kbps channels. The G.726 standard specifies an adaptive differential pulse code modulation (ADPCM) system
for coding and decoding samples.
GSM (Global System for Mobile Communications): A digital cellular phone technology based on time
division multiple access (TDMA) used in Europe, Japan, Australia and elsewhere around the world.
hook state: A general term for the current line status of the channel: either on-hook or off-hook. A telephone
station is said to be on-hook when the conductor loop between the station and the switch is open and no current is
flowing. When the loop is closed and current is flowing, the station is off-hook. These terms are derived from the
position of the old fashioned telephone set receiver in relation to the mounting hook provided for it.
hook switch: The circuitry that controls the on-hook and off-hook state of the voice device telephone interface.
I/O: Input-Output
idle device: A device that has no functions active on it.
in-band: The use of robbed-bit signaling (T1 systems only) on the network. The signaling for a particular channel
or time slot is carried within the voice samples for that time slot, thus within the 64 kbps (kilobits per second) voice
bandwidth.
in-band signaling: (1) In an analog telephony circuit, in-band refers to signaling that occupies the same
transmission path and frequency band used to transmit voice tones. (2) In digital telephony, in-band means
signaling transmitted within an 8-bit voice sample or time slot, as in T1 “robbed-bit” signaling.
kernel: A set of programs in an operating system that implement the system’s functions.
loop: The physical circuit between the telephone switch and the voice processing board.
loop current: The current that flows through the circuit from the telephone switch when the voice device is off-
hook.
loop current detection: A voice driver feature that returns a connect after detecting a loop current drop.
loop start: In an analog environment, an electrical circuit consisting of two wires (or leads) called tip and ring,
which are the two conductors of a telephone cable pair. The CO provides voltage (called “talk battery” or just
“battery”) to power the line. When the circuit is complete, this voltage produces a current called loop current. The
circuit provides a method of starting (seizing) a telephone line or trunk by sending a supervisory signal (going
off-hook) to the CO.
loop-start interfaces: Devices, such as an analog telephones, that receive an analog electric current. For
example, taking the receiver off-hook closes the current loop and initiates the calling process.
mu-law: (1) Pulse Code Modulation (PCM) algorithm used in digitizing telephone audio signals in T1 areas. (2)
The PCM coding and companding standard used in Japan and North America. See also A-law.
off-hook: The state of a telephone station when the conductor loop between the station and the switch is closed
and current is flowing. When a telephone handset is lifted from its cradle (or an equivalent condition occurs), the
telephone line state is said to be off-hook. See also hook state.