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 151

Global Tone Detection and Generation, and Cadenced Tone Generation

dx_deltones( )

Removes all tone templates previously added to a channel with dx_addtone( ). If no tone

templates were previously enabled for this channel, the function has no effect.

dx_deltones( ) does not affect tones defined by build-tone template functions and tone

templates not yet defined. If you have added tones for call progress analysis, these tones are

also deleted.

dx_distone( )

Disables detection of a user-defined tone on a channel as well as the DE_TONEON and/or

DE_TONEOFF events for that tone. Detection capability for user-defined tones is enabled on a

channel by default when dx_addtone( ) is called.

dx_enbtone( )

Enables detection of a user-defined tone that was previously disabled by dx_distone( ). Also

enables detection of DE_TONEON and/or DE_TONEOFF events for that tone. Detection

capability for user-defined tones is enabled on a channel by default when dx_addtone( ) is

called.

13.1.6 Retrieving Tone Events

Tone-on events (DE_TONEON) and tone-off events (DE_TONEOFF) are call status transition

(CST) events. Retrieval of these events is handled differently for asynchronous and synchronous

applications. Table 15 outlines the different processes for retrieving tone events.

You can optionally specify an associated ASCII digit (and digit type) with the tone template. In this

case, the tone template is treated like DTMF tones. When the digit is detected, it is placed in the

digit buffer and can be used for termination. When an associated ASCII digit is specified, tone

events will not be generated for that tone.

Note: Cadence tone on events are reported differently on DM3 boards versus Springware boards. On

DM3 boards, if a cadence tone occurs continuously, a DE_TONEON event is reported for each

on/off cycle. On Springware boards, a DE_TONEON event is reported for the first on/off cycle

only. On both types of boards, a DE_TONEOFF event is reported when the tone is no longer

present.

Table 15. Asynchronous/Synchronous Tone Event Handling

Synchronous Asynchronous

Call dx_addtone( ) or dx_enbtone( ) to

enable tone-on/off detection.

Call dx_addtone( ) or dx_enbtone( ) to

enable tone-on/off detection.

Call dx_getevt( ) to wait for CST event(s).

Events are returned in the DX_EBLK data

structure.

Use Standard Runtime Library (SRL) to

asynchronously wait for TDX_CST event(s).

N/A Use sr_getevtdatap( ) to retrieve DX_CST

data structure.

Note: These procedures are the same as the retrieval of any other CST event, except that

dx_addtone( ) or dx_enbtone( ) are used to enable event detection instead of

dx_setevtmsk( ).