Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Public Attributes | List of all members
om::sound::base::Convolution::Request Class Reference

A class that manages parameters for a convolution instance. More...

#include <omSoundConvolution.h>

Public Member Functions

 Request ()
 Create a new convolution request with the default initial parameters. More...
 

Public Attributes

Size inputChannelCount
 The number of input channels there are for this request. More...
 
Size outputChannelCount
 The number of output channels there are for this request. More...
 
Size irChannelCount
 The number of impulse response channels there are for this request. More...
 
SampleRate sampleRate
 The sample rate that is used for this request. More...
 
Float maxLatency
 The maximum allowed latency of the convolution audio processing stream in seconds. More...
 
Float maxUpdateLatency
 The maximum allowed latency for updates to the IR in seconds. More...
 
Float interpolationTime
 The minimum crossfade interpolation time in seconds that is used when an IR is updated. More...
 

Detailed Description

A class that manages parameters for a convolution instance.

Constructor & Destructor Documentation

om::sound::base::Convolution::Request::Request ( )
inline

Create a new convolution request with the default initial parameters.

Member Data Documentation

Size om::sound::base::Convolution::Request::inputChannelCount

The number of input channels there are for this request.

This value should either be 1 or equal to the number of output channels. If 1, the input channel is used to feed all outputs. If the same number as the output, there is a 1-to-1 mapping of channels. The number of input channels must be at least 1. If the number of input channels is not 1 and not the same as the number of output channels, the unused input channels are fed with the last input channel.

Size om::sound::base::Convolution::Request::outputChannelCount

The number of output channels there are for this request.

The number of output channels must be at least 1.

Size om::sound::base::Convolution::Request::irChannelCount

The number of impulse response channels there are for this request.

The number of IR channels should be either 1 or the number of output channels there are. If equal to 1, the same IR is used on all outputs. If the number of IR channels is not 1 and not the same as the number of output channels, the unused IR channels are fed with the last IR channel.

SampleRate om::sound::base::Convolution::Request::sampleRate

The sample rate that is used for this request.

Float om::sound::base::Convolution::Request::maxLatency

The maximum allowed latency of the convolution audio processing stream in seconds.

The system will attempt to meet this target by altering its processing.

Float om::sound::base::Convolution::Request::maxUpdateLatency

The maximum allowed latency for updates to the IR in seconds.

Decreasing the latency limits the maximum FFT partition size (to less than half this value), but also requires more computation for long IRs.

Float om::sound::base::Convolution::Request::interpolationTime

The minimum crossfade interpolation time in seconds that is used when an IR is updated.


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