Quick start

Licence setup

iris-sdk expects to find the files iris.lic and iris.key in one of the following locations:

  • ~/iris/licence on macos and linux

  • The value of USERPROFILE on windows, eg C:\Users\username\iris\licence

The data root directory can be changed by specifying the IRIS_DATA environment variable as a parent directory of a directory named licence.

Alternatively the licence and key files can be passed in as strings on initialisation.

General Usage

To process audio through iris-sdk:

  • Set up the licence file

  • Create an audio processing context by passing an audio context request to the create audio context function

  • Prepare input and output buffers

  • While unprocessed audio is available

    • place the unprocessed audio into the input buffer

    • call the process function with a context id and the input / output buffers

    • take the processed audio from the output buffer and use as required