Introduction to the NxLib API¶
Note
This topic covers the basic NxLib API, which is accessible through the C API or wrappers for other programming languages. To read about other high-level interfaces please refer to:
Tree Structure¶
The entire NxLib API is based on a JSON-like tree structure. The NxLib DLL exports a small set of basic API functions, which allow to read and write nodes within this tree. Nodes are identified by their path in the tree.
The structure of the tree contains all parameters of the connected cameras as well as the NxLib itself. They are represented as JSON values.
An example of the tree structure as displayed in NxTreeEdit, with one camera node unfolded.¶
Commands¶
In addition to manipulating the plain JSON data in the tree structure, the NxLib can execute various commands, which provide more high-level functionality.
Commands are executed through the special /Execute node within the tree structure. Each command can take parameters from the tree and output a result to the tree.
The specification of the available commands provides a reference of their parameters and results. For an overview of the different types of images and data which can be processed by commands, see the binary pipeline.
Language Wrappers¶
On top of the basic C API, there are also small object-oriented wrappers for other programming languages: