Document Outline

• Contents
• About this Publication
  • Introduction
    • Related Documents
    • Operating System Support
    • Manual Conventions
  • Terminology
    • Updated Terminology
  • Getting Technical Support
• 1 - Introduction to the Dialogic® Brooktrout® Bfv API
  • Bfv API and Associated Libraries
  • The Bfv API Functions
    • Administration, Management, and Configuration
      • Administration and Initialization Functions and Macros
      • Firmware Functions and Macros
      • Configuration Functions
      • Module Status and Monitoring Functions
      • Debugging, Error Handling, and Return Values
      • Miscellaneous Functions and Macros
    • Call Control
      • Bfv Call Control
      • BSMI-Level Call Control
    • Media Processing
      • Signal Generation and Tone Detection
      • Voice Record and Play
      • Fax Functions
      • File Format Manipulation Functions
      • The Infopkt Stream
      • Fax Infopkt Parameters
• 2 - Developing Applications Using the Bfv API
  • Developing a Voice Application
    • Recording and Playing Voice
      • Recording Voice
      • Playing Back the Voice Message
  • Using Prompt Files
    • Using the mkprompt Utility
    • Creating a New Prompt File
    • Updating an Existing Prompt File
  • Developing a Fax Application
    • Sending and Receiving a Fax
      • Sending a Fax from One Channel to Another
      • Sending a Fax to a Channel from an External Fax Machine
    • Using Bfv API Fax Functions
      • Using High- and Low-Level Functions
      • Sending a Fax Using Function Calls for Noninfopkt-Formatted Raw G3 Files
      • Receiving a Fax Using Function Calls for Noninfopkt-Formatted Raw G3 Files
      • Sending a Fax Using Calls for TIFF-F Files
      • Receiving a Fax Using Calls for TIFF-F Files
      • Receiving and Storing a Fax in MMR or MR Format
    • Accessing an Infopkt Stream from an Application
    • Sending a TIFF-F Fax File Within an Infopkt Stream
      • Combining Data on a Single Page Using TIFF-F Fax Files
      • Accessing a TIFF-F File from an Application
    • Determining Fax Status Information from an Application
• 3 - Debugging
  • Bfv API Debug Mode
  • BfvDataFSK
  • BfvLineDumpStructure
  • Dump History
    • Invoking Dump History
    • Interpreting the Output
      • Status Header Line
      • Event Logging Lines
      • Event Logging Line Format
  • Parsed Command Information
  • Utility Programs for Debugging
    • btver
    • connlist
    • feature -q
    • modinfo
    • shoparam
  • BSMI Debugging
    • BSMI Message Tracing
      • Running a Layer 2 Trace
      • Understanding Trace Hexadecimal Strings
    • VTTY Tracing Feature
      • VTTY Console Commands
      • VTTY Tracer GUI
  • Call Tracer
    • Command Syntax
      • Arguments
    • Configuration File Format
• 4 - Sample Applications and Utilities
  • boardmon
  • btver
  • connlist
  • csend
  • deact
  • debug_control
  • decode
  • dfax
  • divert
  • dlfax
  • dstrip
  • eccllvoice
  • fax
  • faxhl
  • faxll
  • faxml
  • faxp
  • faxpml
  • feature
  • firm
  • firmload
  • font
  • ipstrip
  • ivr
  • mkdcx
  • mkinfopk
  • mkprompt
  • mktiff
  • modinfo
  • playp
  • rtp
  • shoparam
  • telreset
  • telsave
  • tfax
  • tiffdump
  • tones
  • transfer
  • transferll
  • trombone
  • tstrip
  • voice
  • voiceraw
  • wave
  • Compiling Sample Applications Using Microsoft® Developer Studio Project Files
    • Using Brooktrout Files
  • Compiling Sample Applications Using Makefiles
    • Combining the Sample Applications
    • Compatibility for Compiling
• 5 - Transferring Calls
  • Making Call Transfers Using Bfv
  • Making Hookflash Transfers
    • Using Bfv Applications
    • Using BSMI Applications
  • Making Two B-Channel Transfers
  • Making Call Transfers Using QSIG
    • ISDN QSIG
    • Supplementary Services Support
  • Making Call Transfers Using Active Redirection (Japan)
  • Making Explicit Call Transfers (ECT) With E1 ISDN and BRI
  • Making Two-Channel Call Transfers (Tromboning)
    • Setting up the Two-Channel Call Transfer
      • Connecting Resources
    • Actions During a Two-Channel Call Transfer
      • Performing Echo Cancellation
      • Playing Back Voice Recordings
    • Terminating the Two-Channel Call Transfer
    • Disconnecting Resources
  • Transferring Calls Using Release Link Trunk Transfer
    • Using Bfv Applications
    • Using BSMI Applications
      • Call Control Sequence Diagrams
      • Non-RLT Call Transfer
      • RLT Call Transfer
    • Sample Application
  • Placing Calls on Hold Using BSMI
• 6 - Managing Fax and Voice over IP Sessions
  • Managing Calls Using IP Telephony
    • Adding IP Call Control using the Bfv API
      • Outgoing IP Calls
      • Incoming IP Calls
    • Understanding SIP Functionality
      • Using a SIP Proxy Server
      • Verifying Dialed Strings
      • Sample INVITE Request
      • Call Progress Values
    • Understanding H.323 Functionality
      • Using H.323 Address Forms
  • Failover Based on Telephony Cause Codes
    • Overview
    • Common Failures
    • Failover Scenarios
    • Known Failures From Various Gateways
      • H.323 and SIP
    • SIP to Q.931 Conversion
  • Processing Media Using the T.38 Protocol
    • Sending and Receiving Faxes
  • Configuring T.38, RTP and IP Call Control Activities
  • Troubleshooting
  • Understanding the SIP Protocol
    • Introduction to the SIP Protocol
    • Overview of SIP Functionality
    • Overview of Operation
  • Using Third Party IP Stacks
    • Integrating Bfv IP Fax
      • Components
    • Configuration
      • Disable ECC Component
      • SR140 Software-Based Integration - Linux
      • TR1034 Board-Based Integration - Linux
    • Call Negotiation
      • Inbound Call
      • Outbound Call
• 7 - Robbed Bit Signaling
  • General Information
    • Timer Definitions
    • Timing Diagrams
  • Wink Start & Delay Dial Signaling
    • Incoming Call Processing
    • Outgoing Call Processing
    • Call Teardown Processing
  • Wink Start with Feature Group B & D
    • Incoming Call Processing
    • Outgoing Call Processing
    • Call Teardown Processing
  • Immediate Start/Fixed Pause Signaling
    • Incoming Call Processing (Immediate Start)
    • Outgoing Call Processing (Fixed Pause Mode)
    • Call Teardown Processing
  • Ground Start Signaling
    • FXO Ground Start
      • Incoming Call Processing
      • Outgoing Call Processing
      • Call Teardown Processing
    • FXS Ground Start
      • Incoming Call Processing
      • Outgoing Call Processing
      • Call Teardown Processing
  • Loop Start Signaling
    • FXO Loop Start
      • Incoming Call Processing
      • Outgoing Call Processing
      • Call Teardown Processing
    • FXS Loop Start
      • Incoming Call Processing
      • Outgoing Call Processing
      • Call Teardown Processing
• 8 - ISDN Call Processing and Management
  • ISDN Call Processing Overview
    • Making an ISDN Incoming Call
    • Making an ISDN Outgoing Call
      • ISDN Overlapped Dialing
    • ISDN Call Clearing - Initiated by Module
    • ISDN Call Clearing - Initiated by Network
  • Translating Q.931 to Simple Message Interface
  • Using the overlap_rcv feature of L4L3mENABLE_PROTOCOL
    • What is Overlap Receive?
    • BSMI Reference Notes
    • How Overlap Receive Mode Changes Call Control Events Presentation
  • Q.921/Q.931 Timers
• 9 - Using the BSMI R2 Signaling Capability
  • CPE Signaling Model
  • Enabling the R2 Protocol
    • Protocol Parameter Mechanics
    • Forward Channel
    • Backward Channel
    • R2 Call Control
    • Outbound Call Setup
    • Inbound Call Setup
    • Call Tear Down
    • Channel Blocking
• 10 - Packaging Your Application for Windows®
  • Package Options
  • Installation
    • Installing Modules
    • Installing Virtual Modules (SR140)
    • Installing Software
      • Installing the Brooktrout SDK
      • About the Merge Module Feature
      • Installing the Merge Module Feature
      • Integrating the Modules
  • About Plug and Play Components
    • Plug and Play Installation Scenarios
    • Structure of the Brooktrout PnP Folder
    • About the INF File
    • About the Dialogic® Brooktrout® Plug and Play Co-Installer
    • About the Device Property Page
  • Modifying Configuration Files
    • User-Defined Configuration File (btcall.cfg)
    • Call Control (callctrl.cfg) Configuration File
  • Including the Brooktrout Configuration Tool
  • Downloading Firmware Files
  • Removing Software
  • Removing the Plug and Play Driver
    • For Earlier Versions (Prior to 5.2)
    • For Version 5.2
• G3 Legacy Utilities
  • ASCII to Fax Conversion Utility (asctog3)
  • Cut and Paste Utilities
    • Cut Utility (g3chop)
    • Paste Utility (g3combin)
  • Epson to Fax Conversion Utility (epstog3)
  • Fax Display and Edit Utility: Supershow (ss)
  • G3 Conversion Utility (g3cvt)
  • Print Utility (p)
• Recompiling On Linux Platforms
• Glossary
• Index