NMS Logo

NaturalFax Developer's Reference Manual

P/N 60009-11
Version

Table of Contents Index NMS Glossary Previous Page Next Page Version

Table of Contents

1 Introduction

1.1 Introduction
1.2 NaturalFax
1.3 CT Access Environment
1.3.1 Programming Model
1.3.2 CT Access Components
1.3.3 Managing NaturalFax Parameters in CT Access

2 Configuring NaturalFax

2.1 Setting Environment Variables
2.1.1 Setting Environment Variables (Windows NT)
2.1.2 Setting Environment Variables (UnixWare)
2.1.3 Setting Environment Variables (Solaris)
2.2 Modifying Your CT Access Configuration File
2.2.1 Sample CT Access Configuration File
2.3 Modifying the Board Configuration File
2.3.1 Modifying the Configuration File for AG Quad Boards
2.3.2 Modifying the Configuration File for AG 2000 and
AG 4000 Boards
2.3.3 Sample AG Configuration File for AG Quad T1
2.3.4 Sample Configuration File for AG 2000/200
2.3.5 Sample Configuration File for AG 4000/1600
2.4 Verifying the Installation
2.4.1 Verifying the NaturalFax Library
2.4.2 Sending and Receiving a Fax

3 Developing NaturalFax Applications

3.1 Introduction
3.1.1 Preparing the Hardware Environment
3.2 Setting Up the CT Access Environment
3.2.1 Using CT Access Services With NaturalFax
3.2.2 Initializing CT Access Services
3.2.3 Creating Event Queues and CTA Contexts
3.2.4 Opening Services
3.3 Establishing a Call
3.3.1 Placing a Call
3.3.2 Receiving a Call
3.4 Working With Document Queues
3.4.1 Building a Document Queue
3.5 Transmitting and Receiving Faxes
3.5.1 Transmitting Faxes
3.5.2 Receiving Faxes
3.5.3 Polling the Called Fax Terminal
3.5.4 Answering a Poll Request
3.5.5 Resetting a Document Queue
3.6 Performing Offline Image Conversion
3.7 Performing Online Image Conversion
3.7.1 Image Conversion During Fax Transmission
3.7.2 Image Conversion During Fax Reception
3.7.3 Generating TIFF-S Files on Receive
3.8 Monitoring Fax Session Status
3.8.1 Tracing NaturalFax Applications
3.8.2 Error Handling During a Fax Session
3.9 Terminating and Shutting Down
3.9.1 Tearing Down or Resetting a Document Queue
3.10 Closing CT Access Services

4 Configuration and Performance Optimization

4.1 Introduction
4.2 Maximizing Ports for Fax Transmission
4.3 Maximizing Universal Ports
4.4 System CPU Load Test Examples
4.4.1 AG Board Example
4.4.2 QX 2000 Board Example

5 Image Format Characteristics

5.1 Introduction
5.2 About Image Format Characteristics
5.2.1 Encoding Formats
5.2.2 Resolution Formats
5.2.3 Page Width Formats
5.3 Options for Storing and Converting Image Data
5.4 T.37 and TIFF-S

6 Function Summary

6.1 Introduction
6.2 Working With Document Queues
6.3 Transmitting and Receiving Documents
6.4 Managing Image Format Conversion
6.5 Managing Pages and Document Contents
6.6 Monitoring Status

7 NaturalFax Function Reference

7.1 Introduction
nfxAnswerFaxPoll
nfxCheckTIFF
nfxConvertFileDirect
nfxCreateQueue
nfxDestroyQueue
nfxEnqueueDoc
nfxGetDocStatus
nfxGetSessionStatus
nfxMergeFile
nfxReceiveFax
nfxResetQueue
nfxSendFax
nfxSplitFile
nfxStopSession

8 Demonstration Programs and Utilities

8.1 Introduction
Using Voice and Fax: caller
Using Voice and Fax: faxback
Receiving a Fax: nfxrecv
Sending a Fax: nfxsend
Verifying TIFF-F or TIFF-S Format: nfxcheck
Converting TIFF-F or TIFF-S Files: nfxcnvrt
Merging TIFF-F or TIFF-S Files: nfxmerge
Splitting TIFF-F or TIFF-S Files: nfxsplit
Converting ASCII Files: nfxtxttf

Appendix A Error Summary

Introduction
Alphabetical Error Summary
Numerical Error Summary

Appendix B Event Summary

Introduction
Events
Completion Events
Errors and Reasons for the Value Field
Informational Events
Confirmation Events

Appendix C Data Structures

Introduction
Parameter Structures
NFX_TRANSMIT_PARMS
NFX_RECEIVE_PARMS
NFX_DOC_PARMS
NFX_CONVERT_PARMS
Status Structures
NFX_FAX_STATUS
NFX_DOC_STATUS
NFX_CHECK_STATUS

Appendix D NaturalFax Parameters

Introduction
NFX_TRANSMIT_PARMS
Dependent Functions
Related Data Structure
NFX_TRANSMIT_PARMS Fields
NFX_RECEIVE_PARMS
Dependent Functions
Related Data Structure
NFX_RECEIVE_PARMS Fields
NFX_DOC_PARMS
Dependent Function
Related Data Structures
NFX_DOC_PARMS Fields
NFX_CONVERT_PARMS
Dependent Function
Related Data Structures
NFX_CONVERT_PARMS Fields

Appendix E NaturalFax DSP Requirements for AG Hardware

NaturalFax DSP Requirements for AG Boards
NaturalFax DSP Requirements for AG 2000/4000 Boards

Appendix F Group 3 Fax Technology

Fax Protocols
Group 3 Protocol
Phase A - Call Setup
Phase B - Pre-Message Procedure
Phase C - Image Transfer and Message Transmission
Phase D - Post-Message Procedures
Phase E - Call Release
Non-Standard Facilities Frame

Appendix G Modem Metrics

Introduction
Signal To Noise Ratio (SNR)
Training Check Frame (TCF)
Using SNR and TCF Together

Table of Contents Index NMS Glossary Previous Page Next Page Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.