User's Manual

ManualsBrandsIntel ManualsMicrocassette RecorderIntel Voice API 52377002

151

152

153

154

155

156

157

158

159

160

Table Of Contents

Contents
Figures
Tables
Revision History
About This Publication
- Purpose
- Applicability
- Intended Audience
- How to Use This Publication
- Related Information
1. Product Description
- 1.1 Overview
- 1.2 R4 API
- 1.3 Call Progress Analysis
- 1.4 Tone Generation and Detection Features
- 1.5 Dial Pulse Detection
- 1.6 Play and Record Features
- 1.7 Send and Receive FSK Data
- 1.8 Caller ID
- 1.9 R2/MF Signaling
- 1.10 TDM Bus Routing
2. Programming Models
- 2.1 Standard Runtime Library
- 2.2 Asynchronous Programming Models
- 2.3 Synchronous Programming Model
3. Device Handling
- 3.1 Device Concepts
- 3.2 Voice Device Names
4. Event Handling
- 4.1 Overview of Event Handling
- 4.2 Event Management Functions
5. Error Handling
6. Application Development Guidelines
- 6.1 General Considerations
- 6.2 Fixed and Flexible Routing Configurations
- 6.3 Fixed Routing Configuration Restrictions
- 6.4 Additional DM3 Considerations
- 6.5 Using Wink Signaling
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.6.1 Positive Voice Detection (PVD)
  - 7.6.2 Positive Answering Machine Detection (PAMD)
- 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.12.1 Positive Voice Detection (PVD)
  - 7.12.2 Positive Answering Machine Detection (PAMD)
- 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.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
- 9.1 Speed and Volume Control Overview
- 9.2 Speed and Volume Convenience Functions
- 9.3 Speed and Volume Adjustment Functions
- 9.4 Speed and Volume Modification Tables
- 9.5 Play Adjustment Digits
- 9.6 Setting Play Adjustment Conditions
- 9.7 Explicitly Adjusting Speed and Volume
10. Send and Receive FSK Data
- 10.1 Overview of ADSI and Two-Way FSK Support
- 10.2 ADSI Protocol
- 10.3 ADSI Operation
- 10.4 One-Way ADSI
- 10.5 Two-Way ADSI
  - 10.5.1 Transmit to On-Hook CPE
  - 10.5.2 Two-Way FSK
- 10.6 Fixed-Line Short Message Service (SMS)
- 10.7 ADSI and Two-Way FSK Voice Library Support
  - 10.7.1 Library Support on DM3 Boards
  - 10.7.2 Library Support on Springware Boards
- 10.8 Developing ADSI Applications
- 10.9 Modifying Older One-Way ADSI Applications
11. Caller ID
- 11.1 Overview of Caller ID
- 11.2 Caller ID Formats
- 11.3 Accessing Caller ID Information
- 11.4 Enabling Channels to Use the Caller ID Feature
- 11.5 Error Handling
- 11.6 Caller ID Technical Specifications
12. Cached Prompt Management
- 12.1 Overview of Cached Prompt Management
- 12.2 Using Cached Prompt Management
- 12.3 Cached Prompt Management Example Code
13. Global Tone Detection and Generation, and Cadenced Tone Generation
- 13.1 Global Tone Detection (GTD)
- 13.2 Global Tone Generation (GTG)
- 13.3 Cadenced Tone Generation
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
- 15.1 R2/MF Overview
- 15.2 Direct Dialing-In Service
- 15.3 R2/MF Multifrequency Combinations
- 15.4 R2/MF Signal Meanings
- 15.5 R2/MF Compelled Signaling
- 15.6 R2/MF Voice Library Functions
- 15.7 R2/MF Tone Detection Template Memory Requirements
16. Syntellect License Automated Attendant
- 16.1 Overview of Automated Attendant Function
- 16.2 Syntellect License Automated Attendant Functions
- 16.3 How to Use the Automated Attendant Function Call
17. Building Applications
- 17.1 Voice and SRL Libraries
- 17.2 Compiling and Linking
Glossary
Index

Voice API Programming Guide — June 2005 153

Global Tone Detection and Generation, and Cadenced Tone Generation

deviation of each of the two tones minus any overlap (and minus any truncation by the GTD

detection range).

For example:

• Single Tone: 400 Hz (125 Hz deviation) = bandwidth of 275 to 525 Hz, total of 250 Hz.

• Dual Tone: 450 Hz (50 Hz deviation) and 1000 Hz (75 Hz deviation) = bandwidth of 400 to

500 Hz and 925 to 1075 Hz, total of 250 Hz.

• Dual Tone: 450 Hz (100 Hz deviation) and 600 Hz (100 Hz deviation) = bandwidth of 350 to

550 Hz and 500 to 700 Hz; eliminating overlap, total range = 350 to 700 Hz, total of 350 Hz.

Each tone costs, on average, 1 + round up [1/16 * round up (total frequency range /62.5)].

This allows for:

• 1 memory block for the actual template

• 1/16 portion of a memory block for an index entry

• range/62.5 multiple indexing for speed

In practice, the 1/16 should be added across tones that have frequency overlap, rather than rounded

up for each tone.

Note: The firmware will often use memory more efficiently than described by the guidelines given above.

These guidelines estimate the maximum memory usage for user-defined tones; the actual usage

may be lower.

13.1.10 Guidelines for Creating User-Defined Tones

The following guidelines apply when creating user-defined tones:

Note: The terms “user-defined tones” and “tone templates” are used interchangeably. Each tone template

specifies the characteristics of one user-defined tone.

• The maximum number of user-defined tone templates is based on tone templates that define a

dual tone with a frequency range (bandwidth) of 63 Hz. (The detection range is the difference

between the minimum and maximum defined frequencies for the tone.)

• On DM3 boards, the maximum number of tone templates is about 40.

• On DM3 boards, the number of user-defined tone templates that are active and enabled on a

channel is limited due to the number of events that a channel can report. The default maximum

number of events for a channel is 20. (A tone-on event and a tone-off event in the same tone

template count as two events.)

• On DM3 boards, the default call progress analysis tones (which include tri-tone special

information tone sequences or SIT sequences) are created at board initialization time and are

available for use. If you create new call progress analysis tone templates using

dx_querytone( ), dx_deletetone( ) and dx_createtone( ), each tone template counts as a user-

defined tone template, which reduces the number of user-defined tones you can create.

• On Springware boards, if you use call progress analysis to detect the different call progress

signals (dial tone, busy tone, ringback tone, fax or modem tone), call progress analysis creates

GTD tones. This reduces the number of user-defined tones you can create. Call progress