om::sound::base::Convolution::IRRequest Class Reference

A class that holds parameters for how an impulse response is updated. More...

#include <omSoundConvolution.h>

Public Member Functions
	IRRequest ()
	Create a new IR request with the default parameters. More...

Public Attributes
Index	start
	The sample index in the input IR where the IR used for convolution should start. More...
Size	length
	If non-zero, indicates the number of samples from the IR to use for convolution. More...
Index	delay
	A broadband delay in samples that is applied to the IR. More...
Float	gain
	A linear gain factor that is applied to the IR before convolution. More...
Bool	asynchronous
	A boolean value that indicates whether or not the IR update is asynchronous. More...

Detailed Description

A class that holds parameters for how an impulse response is updated.

Constructor & Destructor Documentation

om::sound::base::Convolution::IRRequest::IRRequest ( )

inline

Create a new IR request with the default parameters.

Member Data Documentation

Index om::sound::base::Convolution::IRRequest::start

The sample index in the input IR where the IR used for convolution should start.

This value effectively trims off the beginning samples of the IR.

Size om::sound::base::Convolution::IRRequest::length

If non-zero, indicates the number of samples from the IR to use for convolution.

Index om::sound::base::Convolution::IRRequest::delay

A broadband delay in samples that is applied to the IR.

Float om::sound::base::Convolution::IRRequest::gain

A linear gain factor that is applied to the IR before convolution.

Bool om::sound::base::Convolution::IRRequest::asynchronous

A boolean value that indicates whether or not the IR update is asynchronous.

If equal to TRUE, the IR is only updated if the convolution system has processed previous pending updated IRs. This can be used to save processing and to allow for more efficient IR updates without any waiting.

If equal to FALSE (default), the IR is always updated, but the calling thread must wait until all previous pending updated IRs are processed before submitting the new one.

---

The documentation for this class was generated from the following file:

• omSoundConvolution.h