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

154 Voice API Programming Guide — June 2005

Global Tone Detection and Generation, and Cadenced Tone Generation

analysis creates 8 GTD tones; this uses 17 memory blocks on each channel on which it is

activated.

• On Springware boards, if you use call progress analysis to identify tri-tone special information

tone (SIT) sequences, call progress analysis creates GTD tones, which reduces the number of

user-defined tones you can create. Call progress analysis creates one GTD tone template for

each single frequency tone that you define in the DX_CAP structure. For example, if detecting

the SIT sequences per channel (3 frequencies), the GTD memory will be reduced by 5 blocks.

• On Springware boards, if you initiate call progress analysis and there is not enough memory to

create the GTD tones, you will get an EDX_MAXTMPLT error. This indicates that you are

trying to exceed the maximum number of GTD tones.

• On Springware boards, if you use a build tone function (such as dx_blddt( ) or

r2_creatfsig( )) to define a user-defined tone that alone or with existing user-defined tones

exceeds the available memory, you will get an EDX_MAXTMPLT error.

• On Springware boards on Linux, call progress analysis SIT detection releases GTD memory

when call progress analysis has completed. The other features do not release GTD memory

until a dx_deltones( ) is performed.

• On Springware boards on Linux, if you initiate call progress analysis and there is not enough

memory to create the SIT sequences internally, you will get a T_CAERROR event and the

evtdata field will contain MEMERR. On Springware boards on Windows, if you initiate call

progress analysis and there is not enough memory to create the SIT sequences internally, you

will get a CR_MEMERR.

• The dx_deltones( ) function deletes all user-defined tones from a specified channel and

releases the memory that was used for those user-defined tones. When an associated ASCII

digit is specified, tone events will not be generated for that tone.

• If you create R2/MF user-defined tones using r2_creatfsig( ), the voice boards are usually able

to create all 15 R2/MF user-defined tones due to the overlap in frequencies for the R2/MF

signals. If these boards do not have sufficient memory, they may be able to support R2/MF

signaling through a reduced number of R2/MF user-defined tones.

The r2_creatfsig( ) function is not supported on DM3 boards.

• Voice boards support a full set of inbound or outbound R2/MF signals, or the complete Socotel

signal set.

Table 18 lists the maximum number of tone templates for dual tones available on Springware

boards.

For information on maximum amount of memory available for tone templates on Springware

boards, see Table 16, “Maximum Memory Available for User-Defined Tone Templates

(Springware)”, on page 152 and Table 17, “Maximum Memory Available for Tone Templates for

Tone-Creating Voice Features (Springware)”, on page 152.

Table 18. Maximum Tone Templates for Dual Tones (Springware)

Hardware

Tone Templates

Per Board

Tone Templates

Per Channel

D/41JCT-LS 33 8