API Reference

Functions

C++PythonTypescript

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

Structs / Classes / Types

C++PythonTypescript

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

• C++ API Reference
• Python API Reference
• Typescript API Reference