The AcqKnowledge File Format Application Programming Interface (API) is a software library that people with programming knowledge can use to identify and parse information in BIOPAC's ACQ binary file format.
The API is a software library for programmers to use when creating applications—it is not a data extraction program.
The API is the easiest way for people with programming knowledge to extract data from ACQ files for advanced analysis. Use the base functions in a variety of combinations to extract specific data from an ACQ file to use in a new application. The AcqKnowledge API allows you to:
Initialize an ACQ file structure
Close an ACQ file structure
Retrieve channel information
Retrieve samples by segment of a specified channel
Retrieve all the samples of a specified channel
Retrieve a particular sample of a specified channel
Retrieve samples by time slice of a specified channel
Retrieve Journal Text from AcqKnowledge 3.7.3 or below
Retrieve marker information
Retrieve marker text of a specified marker
Use these base functions in a variety of combinations to extract specific data from an ACQ file and then use or transform the data in other analysis programs.
The File Format API can be used to retrieve data from single sample rate files containing stored channels of the same length and saved with the following BIOPAC software products:
Windows - single sample rate, non-compressed, not GLP:
AcqKnowledge 3.7.0 - 3.9.1
Biopac Student Lab 3.7.0 - 3.7.2
AcqKnowledge 4.1 - 4.2
Access to AcqKnowledge 4.2 Journal contents is NOT supported. If Journal access is required in 4.2, please use the "Windows AcqKnowledge 3.7" export option.
Macintosh - non-compressed, not GLP, saved as "Graph (Windows)":
AcqKnowledge 3.7 - 3.9
Biopac Student Lab 3.7.1 - 3.7.2
The API requires a Windows OS. The implementation of these functions is compiled into a Windows 32-bit DLL called "acqfile.dll." Although the interface is documented here in C/C++, any programming language that is able to utilize Windows 32-bit DLLs should be able to access the BIOPAC File Format API. The API was developed using Microsoft Visual Studio C/C++ and is designed to be compatible with Microsoft C++ and Microsoft Visual Basic. The API may work with other developer's tools, but has not been tested for compatibility.
Optional Support License
The API is intended for users with some programming knowledge. Issues that the Support Department can resolve do not require and are not counted toward a license. Optional Support Licenses provide for up to 5, 10, or 20 software-related programming issues that require a programmer to resolve. Click for Support Licenseoptions.
Files:
API 3.0
acqfile.dll
Dynamic link library*
acqfile.h
Header file
acqfile.lib
COFF import library for acqfile.dll
sample.acq
Small .acq file for testing
Directories:
docs
html documentation for the ACQ File Format
cplusplusample
folder containing a sample VC++ 6.0 project
vbsample
folder containing a sample VB 6.0 project
* In order to run executables generated by the sample projects a copy of acqfile.dll must exist in the same directory as the executable.
Open acqfile_8h.htm from the "docs" folder for the Main Page of the documentation and navigate as desired from there, or start with a sample file for C++ or VB projects.
- This API will show you how to create custom software programs that can extract data from files written in the BIOPAC File Format used in AcqKnowledge and Biopac Student Lab software.
BIOPAC File Format API Sample Browser ------------------------------------------- - The BIOPAC File Format API Sample Browser consolidates all of the BIOPAC File Format API documentation. It includes the API Reference Manual and documentation for Sample Projects.
Documentation ------------------------------------------ - Please launch the BIOPAC File Format API Sample Browser to review documentation.
Sample Projects ------------------------------------------ - BIOPAC File Format API 3.0.0 includes several Sample Projects written in various programming languages. Please launch the Hardware Sample Browser to learn more about the Sample Projects.
- The sample projects are located at: [INSTALL DIRECTORY]\SampleProjects
Folder Descriptions ------------------------------------------ - Documentation contains the BIOPAC File Format API Reference Manual - SampleProjects contains Sample Projects and related documentation - SampleBrowser contains the Sample Browser application
Support ------------------------------------------ - E-mail support@biopac.com
- Visit www.biopac.comfor general product and support information.
- Issues that the Support Department can resolve do not require a support license.
- A Support License is required for software-related programming issues that require a programmer to resolve. - One-year Support Licenses are available for up to 5 issues (SUP-5), up to 10 issues (SUP-10), or up to 20 issues (SUP-20). - Support Licenses only apply to developer products: ACKAPI software API, BHAPI hardware API, BIOPAC Basic Scripting license, or Network Data Transfer license.
)
