NMS TAPI Developer's Manual
P/N 60104-10
Version
Version
Table of Contents
1 Introduction
- 1.1 Introduction
- 1.2 NMS TAPI
- 1.3 Telephony Application Programming Interface (TAPI)
- 1.4 Waveform Audio API (WAVE)
- 1.5 NaturalFax for TAPI
2 Configuring NMS TAPI
- 2.1 Configuring NMS TAPI
- 2.1.1 Configuring the System with the NMS Configurator
- 2.2 Adding an NMS Board
- 2.3 Configuring Board-Level Settings
- 2.4 Configuring System-Level Settings
- 2.4.1 Specifying the NMS TAPI Line Configuration
- 2.4.2 Specifying Configuration Files and Locations
- 2.4.3 Configuring Telephony Parameters
- 2.5 Testing the Configuration
- 2.6 Verifying the Installation
- 2.7 Enabling and Disabling NaturalFax for TAPI
3 Using TAPI Functions
- 3.1 TAPI Functions
- 3.1.1 Supported Microsoft TAPI Functions
- 3.1.2 NMS Specific TAPI Functions
- 3.1.3 Supported TAPI Messages
- 3.2 Media Modes
- 3.3 TAPI Call States
- 3.3.1 Inbound Call States
- 3.3.2 Outgoing Call States
4 Using WAVE Functions
- 4.1 Supported WAVE Functions
- 4.2 Supported WAVE Audio Formats
- 4.3 Determining Supported WAVE Formats
- 4.3.1 Using waveInGetDevCaps and waveOutGetDevCaps
- 4.3.2 Using waveInOpen and waveOutOpen
- 4.4 Audio Compression Manager
- 4.5 WAVE Device IDs
- 4.5.1 Managing I/O Buffers
5 Advanced Features
- 5.1 Introduction
- 5.1.1 Making Parameter Changes Take Effect
- 5.2 Using lineDevSpecific
- 5.2.1 Setting Parameters
- 5.2.2 Starting a Protocol
- 5.2.3 Specifying lineOpen Behavior
- 5.2.4 Setting TSP-Specific Parameters
- 5.3 Using lineSetMediaControl
6 Demonstration Program
- 6.1 intapi
7 Using NaturalFax for TAPI Functions
- 7.1 Introduction
- 7.2 NaturalFax Device Class
- 7.3 Programming NaturalFax for TAPI
- 7.4 Handling Events
- 7.5 Working with Document Queues
- 7.5.1 Building a Document Queue
- 7.6 Transmitting and Receiving Faxes
- 7.6.1 Transmitting Faxes
- 7.6.2 Receiving Faxes
- 7.6.3 Polling the Called Fax Terminal
- 7.6.4 Answering a Poll Request
- 7.6.5 Resetting a Document Queue
- 7.6.6 Image Conversion During Fax Transmission
- 7.6.7 Image Conversion During Fax Reception
- 7.7 Monitoring Fax Session Status
- 7.8 Requesting Fax Session Status
- 7.8.1 Error Handling During a Fax Session
- 7.8.2 Tracing NaturalFax for TAPI Applications
- 7.9 Terminating and Shutting Down
- 7.9.1 Tearing Down a Document Queue
- 7.10 Example: Sending a Fax
- 7.11 Example: Receiving a Fax
8 NaturalFax for TAPI Function Reference
- 8.1 Introduction
- 8.2 Function Summary
- 8.2.1 Fax Device Functions
- 8.2.2 Fax Operational Functions
- 8.3 Function Reference
- faxAnswerFaxPoll
- faxClose
- faxCreateQueue
- faxDestroyQueue
- faxEnqueueDoc
- faxGetDocStatus
- faxGetID
- faxGetMessage
- faxGetSessionStatus
- faxOpen
- faxReceiveFax
- faxResetQueue
- faxSendFax
- faxStopSession
Appendix A Troubleshooting
- Introduction
- Installation
- Using the Windows Event Log
- TAPI Functions
- lineInitialize/lineInitializeEx
- lineOpen
- lineMakeCall
- WAVE Functions
Appendix B NMS Board Parameters
- Introduction
- Default Parameters
- Function Parameters
- Trunk Control Program Parameters
- LPS
- WNK
- Configuring Transfer for Wink Start and Loop Start Protocols
Appendix C NaturalFax for TAPI Error Summary
- Introduction
- Alphabetical Error Summary
- Numerical Error Summary
Appendix D NaturalFax for TAPI Parameters
- Introduction
- Parameter Structures
- FAX_TRANSMIT_PARMS
- Dependent Functions
- FAX_TRANSMIT_PARMS Fields
- FAX_RECEIVE_PARMS
- Dependent Functions
- Related Data Structure
- FAX_RECEIVE_PARMS Fields
- FAX_DOC_PARMS
- Dependent Function
- Related Data Structure
- FAX_DOC_PARMS Fields
- FAX_CONVERT_PARMS
- Dependent Function
- Related Data Structure
- FAX_CONVERT_PARMS Fields
- Status Structures
- FAX_SESSION_STATUS
- FAX_DOC_STATUS
- FAX_CHECK_STATUS
Appendix E NaturalFax for TAPI Events
- Introduction
- Completion Events
- Errors and Reasons for the Value Field
- Informational Events
- Confirmation Events
- NaturalFax Events and NaturalFax for TAPI Events
Version
Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights
reserved.