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 201
Index
A
Adaptive Differential Pulse Code Modulation (ADPCM) 91
address signals, R2/MF signaling 175
ADPCM, G.726 91
ADPCM, IMA 90
ADSI_XFERSTRUC data structure 126
, 127
A-law PCM 90
Analog Display Services Interface (ADSI) 21
, 121
answering machine detection 70
asynchronous programming model 23
ATDV_ERRMSGP( ) 29
ATDV_LASTERR( ) 29
ATDX_CONNTYPE( ) 55
, 70
ATDX_CPTERM( ) 47, 61
ATDX_CRTNID( ) 53
, 68
ATDX_FRQDUR( ) 75
ATDX_FRQDUR2( ) 76
ATDX_FRQDUR3( ) 76
ATDX_FRQHZ( ) 75
ATDX_FRQHZ2( ) 75
ATDX_FRQHZ3( ) 76
ATDX_TERMMSK( ) 126
, 127, 156
B
backward signals (CCITT Signaling System tones) 175, 177
basic call progress analysis 44
beginthread( ) 188
busy state 31
busy tone 162
busy tone detection 53
, 68
busy verification tone 162
C
C language interfaces 190
cached prompt management 141
device discovery 141
downloading prompts 142
hints 143
physical board handle 142
playing prompts 142
sample application 144
cadence detection 44
, 78
cadenced tone generation 157
custom tone 157
dx_playtoneEx( ) 157
call progress analysis 44
activating, Springware 62
ATDX_CPERROR( ) 60
ATDX_CPTERM( ) 47
, 61
busy tone detection 53
call outcomes 49, 63
components 45
, 46
dial tone detection 67
disabling, Springware 62
DM3 46
DM3 scenarios 47
DX_CAP parameter structure 48
, 61
errors 60
extended attribute functions, DM3 50
extended attribute functions, Springware 64
fax machine detection, DM3 68
fax tone detection, Springware 53
frequency detection 73
errors 76
initiating, DM3 48
initiating, Springware 62
modem detection 53
, 68
modifying tone definitions, DM3 57
modifying tone definitions, Springware 71
positive answering machine detection, DM3 55
positive answering machine detection, Springware 70
positive voice detection 70
positive voice detection, DM3 55
ringback detection 52
, 67
SIT tones 73
Springware 60
termination results 49
, 63
tone definitions 71
tone detection, DM3 51
tone detection, Springware 66
tone template, DM3 56
tone template, Springware 71
tone types 66
tone types, DM3 51
tri-tone frequency detection parameters 73
types 44
use of global tone detection 71
using Global Call API 44
call progress signals, PBX 160