Summary of the content on the page No. 1
Dialogic® Brooktrout® Fax Products SDK
Developer Guide
Release 6.2
November 2009 931-132-06
www.dialogic.com
Summary of the content on the page No. 2
Copyright and Legal Notice Copyright © 1998-2009 Dialogic Corporation. All Rights Reserved. You may not reproduce this document in whole or in part without permission in writing from Dialogic Corporation at the address provided below. All contents of this document are furnished for informational use only and are subject to change without notice and do not represent a commitment on the part of Dialogic Corporation or its subsidiaries ("Dialogic"). Reasonable effort is made to ensure the accu
Summary of the content on the page No. 3
Hardware Limited Warranty Warranty for Hardware Products: Dialogic Corporation or its subsidiary that originally sold the hardware product ("Dialogic") warrants to the original purchaser of this hardware product, that at the time of delivery the hardware product supplied hereunder will be free from defects in material and workmanship. This warranty is for the standard period set out on Dialogic's website at http://www.dialogic.com/warranties and is void if the defect has resulted from a
Summary of the content on the page No. 4
page 4
Summary of the content on the page No. 5
Bfv API Reference Manual Volumes 1 - 6 Bfv API Reference Manual Bfv API Reference Manual Volume 1 Volume 4 Administration, Management, Fax Processing and Configuration Bfv API Overview Bfv API Overview Fax Overview Administration and Initialization F ax Functions Firmware TIFF-F Files Functions Configuration, Status and Monitoring Debugging, Error Handling and Return Values Miscellaneous Functions Bfv API Reference Manual Bfv API Reference Manual Volume 2 Volume 5
Summary of the content on the page No. 6
Contents Chapter 1 – About this Publication . . . . . . . . . . . . . . . . . . . . . . . . . 16 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Operating System Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Manual Convent
Summary of the content on the page No. 7
Contents BSMI-Level Call Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Media Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Signal Generation and Tone Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Voice Record and Play . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Fax Functions .
Summary of the content on the page No. 8
Contents Determining Fax Status Information from an Application . . . . . . . . . . . . . . . . . . . . . . . 89 Chapter 4 – Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 This chapter describes how to use the debugging tools. Bfv API Debug Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 BfvDataFSK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 9
Contents boardmon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 btver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 connlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 csend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 10
Contents tones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 transferll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 trombone . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 11
Contents Transferring Calls Using Release Link Trunk Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Using Bfv Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Using BSMI Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Call Control Sequence Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 Non-RLT Call Trans
Summary of the content on the page No. 12
Contents Introduction to the SIP Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Overview of SIP Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Overview of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 Using Third Party IP Stacks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 13
Contents Outgoing Call Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 Call Teardown Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 FXS Ground Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 Incoming Call Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 Outgoing Call P
Summary of the content on the page No. 14
Contents CPE Signaling Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337 Enabling the R2 Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 Protocol Parameter Mechanics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 Forward Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 15
Contents Removing the Plug and Play Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 For Earlier Versions (Prior to 5.2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 For Version 5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406 Appendix A – G3 Legacy Utilities . . . . . . . . . . . . . . . . . . . . . . . . . 408 This appendix describes lega
Summary of the content on the page No. 16
About this Publication Introduction The Dialogic® Brooktrout® Fax Products SDK Developer Guide describes the Bfv API used to create applications to control the features of the Dialogic® Brooktrout® TR1034® Fax Boards, Dialogic® Brooktrout® TruFax® Fax Boards, and the Dialogic® Brooktrout® SR140 Fax Software. The manual gives information about Call Transfer, Automatic Speech Recognition, IP functionality, and BSMI functionality. Finally, it explains how one can include and package software
Summary of the content on the page No. 17
R2 signaling Chapter 11 describes how to package software supporting Brooktrout software or SR140 Fax in your product. Appendix A provides instructions for a set of legacy G3 utility programs. Appendix B provides instructions for recompiling the Boston driver to support new kernel patches. A glossary gives definitions for some of the terms used in the manual. A copy of this manual in Adobe Acrobat PDF format is installed in the Documents directory on the Brooktrout TR1034/SR140/TruFax®
Summary of the content on the page No. 18
Italics denote the names of variables in the prototype of a function and file names, directory names, and program names within the general text. The Courier font in bold indicates a command sequence entered by the user at the system prompt, for example: cd /Brooktrout/boston/bfv.api The Courier font not bolded indicates system output, for example: C:>Files installed. The Courier font also denotes programming code, such as C, C++, Microsoft® Visual Basic®, and TSL. Programming code appea
Summary of the content on the page No. 19
Terminology Updated Terminology The current version of this document includes terminology that differs from previous versions. Please note the changes below: Former Terminology Replaced with... Host-based fax Dialogic® Brooktrout® SR140 Fax Software or Virtual modules Brooktrout SR140 Fax Software Virtual boards or Software modules SR140 Software VoIP modules or SR140 virtual modules SR140 TR1000 Series SDK Dialogic® Brooktrout® SDK TR1000 Series Product Dialogic® Brooktrout® Fax Board or T
Summary of the content on the page No. 20
Dialogic® Brooktrout® TR1034 Fax Board Terminology The Dialogic® Brooktrout® TR1034 Fax Board is also referred to herein by one or more of the following terms, or like terms including “TR1034”: Brooktrout TR1034 Fax Board Brooktrout TR1034 Board TR1034 Fax Board TR1034 Board TR1034 November 2009 20
