API Reference
=============

.. rubric:: Functions

.. tabs::

  .. group-tab:: C++

    .. list-table::
      :widths: 25 75
      :header-rows: 0

      * - :cpp:func:`Iris::init`
        - Initialise the sdk
      * - :cpp:func:`Iris::createAudioContext`
        - Creates an audio processing context.
      * - :cpp:func:`Iris::releaseAudioContext`
        - Releases a previously created audio processing context that is no longer required.
      * - :cpp:func:`Iris::process`
        -  Processes sequential chunks of a contiguous audio stream through an existing audio processing context.
      * - :cpp:func:`Iris::processOffline`
        - Processes an entire large audio buffer through an existing audio processing context.
      * - :cpp:func:`Iris::setParameter`
        - Set a value for an existing parameter.
      * - :cpp:func:`Iris::getParameter`
        - Get the current value for an existing parameter.
      * - :cpp:func:`Iris::resetParameters`
        - Resets all parameters in a previously created audio processing context to default values.
      * - :cpp:func:`Iris::findParameterDescription`
        - Find matching parameter descriptions within an audio processing context.
      * - :cpp:func:`Iris::cleanup`
        - Cleanup memory allocated by iris-sdk.
      * - :cpp:func:`Iris::openSourceLicences`
        - Licence information for 3rd-party software used by iris-sdk.

  .. group-tab:: Python

    .. list-table::
      :widths: 25 75
      :header-rows: 0

      * - :func:`iris.sdk.init`
        - Initialise the sdk
      * - :func:`iris.sdk.create_audio_context`
        - Creates an audio processing context.
      * - :func:`iris.sdk.release_audio_context`
        - Releases a previously created audio processing context that is no longer required.
      * - :func:`iris.sdk.process`
        -  Processes sequential chunks of a contiguous audio stream through an existing audio processing context.
      * - :func:`iris.sdk.process_offline`
        - Processes an entire large audio buffer through an existing audio processing context.
      * - :func:`iris.sdk.set_parameter`
        - Set a value for an existing parameter.
      * - :func:`iris.sdk.get_parameter`
        - Get the current value for an existing parameter.
      * - :func:`iris.sdk.reset_parameters`
        - Resets all parameters in a previously created audio processing context to default values.
      * - :func:`iris.sdk.find_parameter_description`
        - Find matching parameter descriptions within an audio processing context.
      * - :func:`iris.sdk.cleanup`
        - Cleanup memory allocated by iris-sdk.
      * - :func:`iris.sdk.open_source_licences`
        - Licence information for 3rd-party software used by iris-sdk.

  .. group-tab:: Typescript

    .. list-table::
      :widths: 25 75
      :header-rows: 0

      * - :func:`iris.init`
        - Initialise the sdk
      * - :func:`iris.createAudioContext`
        - Creates an audio processing context.
      * - :func:`iris.releaseAudioContext`
        - Releases a previously created audio processing context that is no longer required.
      * - :func:`iris.process`
        -  Processes sequential chunks of a contiguous audio stream through an existing audio processing context.
      * - :cpp:func:`iris.processOffline`
        - Processes an entire large audio buffer through an existing audio processing context.
      * - :func:`iris.setParameter`
        - Set a value for an existing parameter.
      * - :func:`iris.getParameter`
        - Get the current value for an existing parameter.
      * - :func:`iris.resetParameters`
        - Resets all parameters in a previously created audio processing context to default values.
      * - :func:`iris.findParameterDescription`
        - Find matching parameter descriptions within an audio processing context.
      * - :func:`iris.cleanup`
        - Cleanup memory allocated by iris-sdk.
      * - :func:`iris.openSourceLicences`
        - Licence information for 3rd-party software used by iris-sdk.


.. rubric:: Structs / Classes / Types

.. tabs::

  .. group-tab:: C++

    .. list-table::
      :widths: 25 75
      :header-rows: 0

      * - :cpp:class:`Iris::LicenceInfo`
        - Initialisation information.
      * - :cpp:class:`Iris::AudioContextRequest`
        - A request for an audio processing context to be created.
      * - :cpp:class:`Iris::AudioContextConfig`
        - An audio processing context configuration.
      * - :cpp:class:`Iris::ParameterDescription`
        - Describes a parameter that can be set on an audio processing context.
      * - :cpp:class:`Iris::ProcessorParameters`
        - A group of ParameterDescription in the order they would be applied within a context.
      * - :cpp:class:`Iris::OpenSourceLicence`
        - Details of third-party Open Source software used within iris-sdk

  .. group-tab:: Python

    .. list-table::
      :widths: 25 75
      :header-rows: 0

      * - :class:`iris.sdk.LicenceInfo`
        - Initialisation information.
      * - :class:`iris.sdk.AudioContextRequest`
        - A request for an audio processing context to be created.
      * - :class:`iris.sdk.AudioContextConfig`
        - An audio processing context configuration.
      * - :class:`iris.sdk.ParameterDescription`
        - Describes a parameter that can be set on an audio processing context.
      * - :class:`iris.sdk.ProcessorParameters`
        - A group of ParameterDescription in the order they would be applied within a context.
      * - :class:`iris.sdk.OpenSourceLicence`
        - Details of third-party Open Source software used within iris-sdk

  .. group-tab:: Typescript

    .. list-table::
      :widths: 25 75
      :header-rows: 0

      * - :class:`iris.Info`
        - Initialisation information.
      * - :class:`iris.AudioContextRequest`
        - A request for an audio processing context to be created.
      * - :class:`iris.AudioContextConfig`
        - An audio processing context configuration.
      * - :class:`iris.ParameterDescription`
        - Describes a parameter that can be set on an audio processing context.
      * - :class:`iris.ProcessorParameters`
        - A group of ParameterDescription in the order they would be applied within a context.
      * - :class:`iris.OpenSourceLicence`
        - Details of third-party Open Source software used within iris-sdk

.. toctree::
  :maxdepth: 1

  cpp_api_reference
  python_api_reference
  typescript_api_reference