Python API Reference
====================

.. rubric:: Functions

.. autofunction:: iris.sdk.init
.. autofunction:: iris.sdk.create_audio_context
.. autofunction:: iris.sdk.release_audio_context
.. autofunction:: iris.sdk.process
.. autofunction:: iris.sdk.process_offline
.. autofunction:: iris.sdk.set_parameter
.. autofunction:: iris.sdk.get_parameter
.. autofunction:: iris.sdk.reset_parameters
.. autofunction:: iris.sdk.find_parameter_description
.. autofunction:: iris.sdk.cleanup
.. autofunction:: iris.sdk.open_source_licences

.. autoattribute:: iris.sdk.ERROR_PROCESSOR_UNSUPPORTED
    :annotation: = An unknown or unsupported processor was requested
.. autoattribute:: iris.sdk.ERROR_SAMPLE_RATE_MISMATCH
    :annotation: = Processors with conflicting sample rates were requested

.. rubric:: Classes

.. autoclass:: iris.sdk.LicenceInfo
  :members:
.. autoclass:: iris.sdk.AudioContextRequest
  :members:
.. autoclass:: iris.sdk.AudioContextConfig
  :members:
.. autoclass:: iris.sdk.ParameterDescription
  :members:
.. autoclass:: iris.sdk.ProcessorParameters
  :members:
.. autoclass:: iris.sdk.OpenSourceLicence
  :members: