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 203
dx_blddtcad( ) 149
dx_bldst( ) 149
dx_bldstcad( ) 149
dx_bldtngen( ) 156
DX_CAP data structure 48
, 61, 70
clearing 35
SIT tone setup 73
dx_chgdur( ) 72
dx_chgfreq( ) 72
dx_chgrepcnt( ) 72
dx_clrcap( ) 35
, 48, 61
dx_clrtpt( ) 35
dx_createtone( ) 58
DX_CST data structure 172
dx_deletetone( ) 58
dx_deltones( ) 62
used with tone templates 151
dx_dial( ) 48
, 61, 62
DM3 support 47
Springware support 47
dx_distone( ) 151
dx_enbtone( ) 151
dx_getcachesize( ) 142
dx_getdig( ) 34
, 118, 171
used with global tone detection 148
dx_getevt( ) 151
dx_getfeaturelist( ) 39
, 126, 127
dx_getparm( ) 126
dx_getsvmt( ) 115
dx_getxmitslot( ) 103
dx_getxmitslotecr( ) 103
dx_gtcallid( ) 137
dx_gtextcallid( ) 137
dx_initcallp( ) 61
, 62
dx_listen( ) 103
dx_mreciottdata( ) 92
dx_open( ) 39
dx_play( ) 88
, 122
dx_playf( ) 88
, 122
dx_playiottdata( ) 92
dx_playtone( ) 156
dx_playtoneEx( )
used with cadenced tone generation 157
dx_playvox( ) 88
dx_querytone( ) 57
dx_rec( ) 88
, 94
dx_recf( ) 88
dx_reciottdata( ) 92
, 95
dx_recm(_) 93
dx_recmf(_) 93
dx_recvox( ) 88
dx_RxIottData( ) 122
dx_RxIottdata( ) 126
, 127
dx_setdevuio( ) 35
dx_setdigtyp( ) 171
dx_setevtmsk( ) 42
, 151
dx_setgtdamp( ) 149
dx_sethook( ) 42
dx_setparm( ) 126
enabling caller ID 138
dx_setsvcond( ) 114
, 118
dx_setsvmt( ) 115, 118
dx_setuio( ) 35
DX_SVCB data structure 118
DX_SVMT data structure 118
dx_TxIottData( ) 122
dx_TxIottdata( ) 126
, 127
dx_TxRxIottData( ) 122
dx_TxRxIottdata( ) 126
, 127
dx_unlistenecr( ) 103
dx_wtcallid( ) 137
DXBD_OFFHDLY 42
DXCH_MAXRWINK 42
DXCH_MINRWINK 42
DXCH_WINKDLY 41
DXCH_WINKLEN 41
dxxxlib.h 190
E
echo cancellation resource (ECR) 102
application models 105
modes of operation 104
echo component 102
echo reference signal 102
echo-carrying signal 102
ECR 101
ECR mode, echo canceller 104
encoding algorithms 89
G.726 details 91
support in SCR 95
supported for recording with VAD 96
enhanced call progress analysis 18
, 44
error handling 29
error handling in caller ID 138