.. _oni-api:

===========================================
ONI API Documentation
===========================================

.. toctree::
    :hidden:
    :maxdepth: 2

    liboni/index
    bindings/index

Core Library
--------------------------
An ANSI-C library for controlling hardware that conforms to the :ref:`ONI
Hardware Specification <oni-hw>`. It contains functions for configuring
hardware, streaming data to and from hardware, and controlling hardware during
operation. This library has minimal external dependencies and is aimed at the
creation of language bindings and/or integration into existing acquisition
software.

- :ref:`Library Reference <liboni>`
- :ref:`Build Instructions <liboni-build>`
- :ref:`Usage Examples <liboni_example>`
- :ref:`Writing Driver Translators <making_drivers>`
- :ref:`Existing Driver Options<drivers>`

Bindings
--------------
:ref:`C++ Binding Reference <cpponi>`
    C++17 & C++20 bindings for :ref:`liboni`.

:ref:`.NET Binding Reference <clroni>`
    CLR/.NET bindings for :ref:`liboni`.