TrueAudio Next

Typedefs

typedef struct _IPLTrueAudioNextDevice_t *IPLTrueAudioNextDevice

Application-wide state for the TrueAudio Next convolution engine.

A TrueAudio Next device must be created before using any of Steam Audio’s TrueAudio Next convolution functionality. In terms of the TrueAudio Next API, this object encapsulates an amf::TANContext and amf::TANConvolution object.

Functions

IPLerror iplTrueAudioNextDeviceCreate(IPLOpenCLDevice openCLDevice, IPLTrueAudioNextDeviceSettings *settings, IPLTrueAudioNextDevice *tanDevice)

Creates a TrueAudio Next device.

Parameters

• openCLDevice – The OpenCL device to use for running TrueAudio Next.

• settings – The settings to use when creating the TrueAudio Next device.

• tanDevice – [out] The created TrueAudio Next device.

Returns

Status code indicating whether or not the operation succeeded.

IPLTrueAudioNextDevice iplTrueAudioNextDeviceRetain(IPLTrueAudioNextDevice device)

Retains an additional reference to a TrueAudio Next device.

Parameters

device – The TrueAudio Next device to retain a reference to.

Returns

The additional reference to the TrueAudio Next device.

void iplTrueAudioNextDeviceRelease(IPLTrueAudioNextDevice *device)

Releases a reference to a TrueAudio Next device.

Parameters

device – The TrueAudio Next device to release a reference to.

Structures

struct IPLTrueAudioNextDeviceSettings

Settings used to create a TrueAudio Next device.

Public Members

IPLint32 frameSize

The number of samples in an audio frame.

IPLint32 irSize

The number of samples in the impulse responses that will be used for convolution.

IPLint32 order

The Ambisonic order of the impulse responses that will be used for convolution.

IPLint32 maxSources

The maximum number of sources that will use TrueAudio Next for convolution.