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
118 Voice API Programming Guide — June 2005
Speed and Volume Control
9.5 Play Adjustment Digits
The voice software processes play adjustment digits differently from normal digits:
• If a play adjustment digit is entered during playback, it causes a play adjustment only and has
no other effect. This means that the digit is not added to the digit queue; it cannot be retrieved
with the dx_getdig( ) function.
• On DM3 boards, digits that are used for play adjustment may also be used as a terminating
condition. If a digit is defined as both, then both actions are applied upon detection of that
digit.
• On Springware boards, digits that are used for play adjustment will not be used as a
terminating condition. If a digit is defined as both, then the play adjustment will take priority.
• If the digit queue contains adjustment digits when a play begins and play adjustment is set to
be level sensitive, the digits will affect the speed or volume and then be removed from the
queue.
9.6 Setting Play Adjustment Conditions
Adjustment conditions are set in the same way for speed or volume. The following steps describe
how to set conditions upon which volume should be adjusted:
1. Set up the volume modification table (if you do not want to use the defaults):
• Set up the DX_SVMT structure to specify the size and number of the steps in the table.
• Call the dx_setsvmt( ) function, which points to the DX_SVMT structure, to modify the
volume modification table (dx_setsvmt( ) can also be used to reset the table to its default
values).
2. Set up the DX_SVCB structure to specify the condition, the size, and the type of adjustment.
3. Call dx_setsvcond( ), which points to an array of DX_SVCB structures. All subsequent plays
will adjust volume as required whenever one of the conditions specified in the array occurs.
See the Voice API Library Reference for more information about these functions and data
structures.
9.7 Explicitly Adjusting Speed and Volume
Speed and volume adjustments are made in the same way. The following steps describe how to
adjust speed, but you can use exactly the same procedure for volume:
1. Set up the speed modification table (if you do not want to use the defaults):
• Set up the DX_SVMT structure to specify the size and number of the steps in the table.
• Call the dx_setsvmt( ) function, which points to the DX_SVMT structure, to modify the
speed modification table (dx_setsvmt( ) can also be used to reset the table to its default
values).
2. When required, call dx_adjsv( ) to adjust the speed modification table by specifying the size
and type of the adjustment.