Om  1.0.0
A universal framework for multimedia simulation
Classes | Public Member Functions | Static Public Attributes | List of all members
om::sound::filters::ParametricEqualizer Class Reference

A class that provides a basic 5-band parametric EQ with additional high/low shelf/pass filters. More...

#include <omSoundParametricEqualizer.h>

Inheritance diagram for om::sound::filters::ParametricEqualizer:
om::sound::filters::SoundFilter

Public Member Functions

 ParametricEqualizer ()
 Create a default parametric equalizer with 5 parametric filter bands. More...
 
Gain getOutputGain () const
 Return the linear output gain for this parametric equalizer. More...
 
Gain getOutputGainDB () const
 Return the output gain in decibels for this parametric equalizer. More...
 
void setOutputGain (Gain newGain)
 Set the linear output gain for this parametric equalizer. More...
 
void setOutputGainDB (Gain newGain)
 Set the output gain in decibels for this parametric equalizer. More...
 
Size getParametricCount () const
 Return the number of parametric EQ filters that make up this parametric equalizer. More...
 
void setParametricCount (Size newNumberOfParametrics)
 Set the number of parametric EQ filters that make up this parametric equalizer. More...
 
Bool getParametricIsEnabled (Index parametricIndex) const
 Return whether or not the parametric filter within this equalizer at the specified index is enabled. More...
 
void setParametricIsEnabled (Index parametricIndex, Bool newIsEnabled)
 Set whether or not the parametric filter within this equalizer at the specified index is enabled. More...
 
Gain getParametricGain (Index parametricIndex) const
 Return the linear gain of the parametric filter within this equalizer at the specified index. More...
 
Gain getParametricGainDB (Index parametricIndex) const
 Return the gain in decibels of the parametric filter within this equalizer at the specified index. More...
 
void setParametricGain (Index parametricIndex, Gain newGain)
 Set the linear gain of the parametric filter within this equalizer at the specified index. More...
 
void setParametricGainDB (Index parametricIndex, Gain newGain)
 Set the gain in decibels of the parametric filter within this equalizer at the specified index. More...
 
Float getParametricFrequency (Index parametricIndex) const
 Return the center frequency of the parametric filter within this equalizer at the specified index. More...
 
void setParametricFrequency (Index parametricIndex, Float newFrequency)
 Set the center frequency of the parametric filter within this equalizer at the specified index. More...
 
Float getParametricQ (Index parametricIndex) const
 Return the Q factor of the parametric filter within this equalizer at the specified index. More...
 
void setParametricQ (Index parametricIndex, Float newQ)
 Set the Q factor of the parametric filter within this equalizer at the specified index. More...
 
Float getParametricBandwidth (Index parametricIndex) const
 Return the bandwidth in octaves of the parametric filter within this equalizer at the specified index. More...
 
void setParametricBandwidth (Index parametricIndex, Float newBandwidth)
 Set the bandwidth in octaves of the parametric filter within this equalizer at the specified index. More...
 
Float getHighPassFrequency () const
 Return the corner frequency of this parametric equalizer's high pass filter. More...
 
void setHighPassFrequency (Float newFrequency)
 Set the corner frequency of this parametric equalizer's high pass filter. More...
 
Size getHighPassOrder () const
 Return the order of this parametric equalizer's high pass filter. More...
 
void setHighPassOrder (Size newOrder)
 Set the order of this parametric equalizer's high pass filter. More...
 
Bool getHighPassIsEnabled () const
 Return whether or not the high pass filter of this parametric equalizer is enabled. More...
 
void setHighPassIsEnabled (Bool newIsEnabled)
 Set whether or not the high pass filter of this parametric equalizer is enabled. More...
 
Float getLowPassFrequency () const
 Return the corner frequency of this parametric equalizer's low pass filter. More...
 
void setLowPassFrequency (Float newFrequency)
 Set the corner frequency of this parametric equalizer's low pass filter. More...
 
Size getLowPassOrder () const
 Return the order of this parametric equalizer's low pass filter. More...
 
void setLowPassOrder (Size newOrder)
 Set the order of this parametric equalizer's low pass filter. More...
 
Bool getLowPassIsEnabled () const
 Return whether or not the low pass filter of this parametric equalizer is enabled. More...
 
void setLowPassIsEnabled (Bool newIsEnabled)
 Set whether or not the low pass filter of this parametric equalizer is enabled. More...
 
Float getLowShelfFrequency () const
 Return the corner frequency of this parametric equalizer's low shelf filter. More...
 
void setLowShelfFrequency (Float newFrequency)
 Set the corner frequency of this parametric equalizer's low shelf filter. More...
 
Gain getLowShelfGain () const
 Return the linear gain of this parametric equalizer's low shelf filter. More...
 
Gain getLowShelfGainDB () const
 Return the gain in decibels of this parametric equalizer's low shelf filter. More...
 
void setLowShelfGain (Gain newGain)
 Set the linear gain of this parametric equalizer's low shelf filter. More...
 
void setLowShelfGainDB (Gain newGain)
 Set the gain in decibels of this parametric equalizer's low shelf filter. More...
 
Float getLowShelfSlope () const
 Return the slope of this parametric equalizer's low shelf filter. More...
 
void setLowShelfSlope (Float newSlope)
 Set the slope of this parametric equalizer's low shelf filter. More...
 
Bool getLowShelfIsEnabled () const
 Return whether or not the low shelf filter of this parametric equalizer is enabled. More...
 
void setLowShelfIsEnabled (Bool newIsEnabled)
 Set whether or not the low shelf filter of this parametric equalizer is enabled. More...
 
Float getHighShelfFrequency () const
 Return the corner frequency of this parametric equalizer's high shelf filter. More...
 
void setHighShelfFrequency (Float newFrequency)
 Set the corner frequency of this parametric equalizer's high shelf filter. More...
 
Gain getHighShelfGain () const
 Return the linear gain of this parametric equalizer's high shelf filter. More...
 
Gain getHighShelfGainDB () const
 Return the gain in decibels of this parametric equalizer's high shelf filter. More...
 
void setHighShelfGain (Gain newGain)
 Set the linear gain of this parametric equalizer's high shelf filter. More...
 
void setHighShelfGainDB (Gain newGain)
 Set the gain in decibels of this parametric equalizer's high shelf filter. More...
 
Float getHighShelfSlope () const
 Return the slope of this parametric equalizer's high shelf filter. More...
 
void setHighShelfSlope (Float newSlope)
 Set the slope of this parametric equalizer's high shelf filter. More...
 
Bool getHighShelfIsEnabled () const
 Return whether or not the high shelf filter of this parametric equalizer is enabled. More...
 
void setHighShelfIsEnabled (Bool newIsEnabled)
 Set whether or not the high shelf filter of this parametric equalizer is enabled. More...
 
virtual UTF8String getName () const
 Return a human-readable name for this parametric equalizer. More...
 
virtual UTF8String getManufacturer () const
 Return the manufacturer name of this parametric equalizer. More...
 
virtual FilterVersion getVersion () const
 Return an object representing the version of this parametric equalizer. More...
 
virtual FilterCategory getCategory () const
 Return an object that describes the category of effect that this filter implements. More...
 
virtual Bool allowsInPlaceProcessing () const
 Return whether or not this parametric equalizer can process audio data in-place. More...
 
virtual Size getParameterCount () const
 Return the total number of generic accessible parameters this filter has. More...
 
virtual Bool getParameterInfo (Index parameterIndex, FilterParameterInfo &info) const
 Get information about the parameter at the specified index. More...
 
- Public Member Functions inherited from om::sound::filters::SoundFilter
virtual ~SoundFilter ()
 Destroy this sound filter object. More...
 
SoundResult read (SoundBuffer &outputBuffer, Size numSamples)
 Fill the specified output buffer with the requested number of samples, based on internal filter state. More...
 
SoundResult read (SoundFrame &outputFrame, Size numSamples)
 Fill the specified output frame with the requested number of samples, based on internal filter state. More...
 
SoundResult write (const SoundBuffer &inputBuffer, Size numSamples)
 Process the specified input buffer samples and do something with them. More...
 
SoundResult write (const SoundFrame &inputFrame, Size numSamples)
 Process the specified input frame samples and do something with them. More...
 
SoundResult process (const SoundBuffer &inputBuffer, SoundBuffer &outputBuffer, Size numSamples)
 Apply this filter to the specified input buffer data, placing the result in the output buffer. More...
 
SoundResult process (const SoundBuffer &inputBuffer, SoundFrame &outputFrame, Size numSamples)
 Apply this filter to the specified input buffer data, placing the result in the output frame. More...
 
SoundResult process (const SoundFrame &inputFrame, SoundFrame &outputFrame, Size numSamples)
 Apply this filter to the specified input frame data, placing the result in the output frame. More...
 
SoundResult process (const SoundFrame &inputBuffer, SoundBuffer &outputBuffer, Size numSamples)
 Apply this filter to the specified input frame data, placing the result in the output buffer. More...
 
void reset ()
 Signal to the filter that the audio stream is restarting. More...
 
UInt64 getFrameIndex () const
 Return the index of the next frame to be processed (or the current one if currently processing). More...
 
Size getInputCount () const
 Return the current number of audio inputs that this filter has. More...
 
virtual UTF8String getInputName (Index inputIndex) const
 Return a human-readable name of the filter audio input at the specified index. More...
 
Size getOutputCount () const
 Return the current number of audio outputs that this filter has. More...
 
virtual UTF8String getOutputName (Index outputIndex) const
 Return a human-readable name of the filter audio output at the specified index. More...
 
Size getMIDIInputCount () const
 Return the current number of MIDI inputs that this filter has. More...
 
virtual UTF8String getMIDIInputName (Index inputIndex) const
 Return a human-readable name of the filter MIDI input at the specified index. More...
 
Size getMIDIOutputCount () const
 Return the current number of MIDI outputs that this filter has. More...
 
virtual UTF8String getMIDIOutputName (Index outputIndex) const
 Return a human-readable name of the filter MIDI output at the specified index. More...
 
virtual Time getLatency () const
 Return a Time value indicating the latency of this sound filter in seconds. More...
 
virtual Bool getParameterIndex (const UTF8String &parameterName, Index &parameterIndex) const
 Query the index of the parameter with the specified name. More...
 
virtual Bool getParameterValueName (Index parameterIndex, const FilterParameter &value, UTF8String &name) const
 Get any special name associated with the specified value of an indexed parameter. More...
 
Bool getParameter (Index parameterIndex, FilterParameter &value) const
 Place the value of the parameter at the specified index in the output parameter. More...
 
Bool getParameter (Index parameterIndex, Bool &value) const
 Place the value of the parameter at the specified index in the output parameter. More...
 
Bool getParameter (Index parameterIndex, Int64 &value) const
 Place the value of the parameter at the specified index in the output parameter. More...
 
Bool getParameter (Index parameterIndex, Float32 &value) const
 Place the value of the parameter at the specified index in the output parameter. More...
 
Bool getParameter (Index parameterIndex, Float64 &value) const
 Place the value of the parameter at the specified index in the output parameter. More...
 
template<typename ParameterType >
Bool getParameter (const UTF8String &name, ParameterType &value) const
 Place the value of the parameter with the specified name in the output parameter. More...
 
template<typename ParameterType >
Bool getParameter (const char *name, ParameterType &value) const
 Place the value of the parameter with the specified name in the output parameter. More...
 
Bool setParameter (Index parameterIndex, const FilterParameter &value)
 Attempt to set the parameter value at the specified index. More...
 
Bool setParameter (Index parameterIndex, Bool value)
 Attempt to set the parameter value at the specified index. More...
 
Bool setParameter (Index parameterIndex, Int64 value)
 Attempt to set the parameter value at the specified index. More...
 
Bool setParameter (Index parameterIndex, Float32 value)
 Attempt to set the parameter value at the specified index. More...
 
Bool setParameter (Index parameterIndex, Float64 value)
 Attempt to set the parameter value at the specified index. More...
 
template<typename ParameterType >
Bool setParameter (const UTF8String &name, ParameterType value)
 Attempt to set the parameter value with the specified name. More...
 
template<typename ParameterType >
Bool setParameter (const char *name, ParameterType value)
 Attempt to set the parameter value with the specified name. More...
 
virtual Bool writeState (DataOutputStream &stream) const
 Write the current state of this sound filter to a data output stream. More...
 
virtual Bool readState (DataInputStream &stream)
 Read a previously saved filter state from the specified data input stream and replace the filter's state. More...
 
virtual Size getPresetCount () const
 Return the number of standard configuration presets that this sound filter has. More...
 
virtual Bool getPreset (Index presetIndex, FilterPreset &preset) const
 Get the standard preset for this sound filter with the specified index. More...
 
Bool getIsSynchronized () const
 Return whether or not this sound filter performs thread synchronization. More...
 
void setIsSynchronized (Bool newIsSynchronized)
 Set whether or not this sound filter performs thread synchronization. More...
 

Static Public Attributes

static const UTF8String NAME
 A string indicating the human-readable name of this parametric equalizer. More...
 
static const UTF8String MANUFACTURER
 A string indicating the manufacturer name of this parametric equalizer. More...
 
static const FilterVersion VERSION
 An object indicating the version of this parametric equalizer. More...
 
- Static Public Attributes inherited from om::sound::filters::SoundFilter
static const om::resources::ResourceType RESOURCE_TYPE
 The resource type for a sound filter. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from om::sound::filters::SoundFilter
static Size getMaximumNumberOfInputs ()
 Return the maximum number of audio inputs that a SoundFilter can support. More...
 
static Size getMaximumNumberOfOutputs ()
 Return the maximum number of audio outputs that a SoundFilter can support. More...
 
static Size getMaximumNumberOfMIDIInputs ()
 Return the maximum number of MIDI inputs that a SoundFilter can support. More...
 
static Size getMaximumNumberOfMIDIOutputs ()
 Return the maximum number of MIDI outputs that a SoundFilter can support. More...
 
- Protected Member Functions inherited from om::sound::filters::SoundFilter
 SoundFilter ()
 Create a new sound filter with 1 audio input and output, and no MIDI inputs or outputs. More...
 
 SoundFilter (Size numInputs, Size numOutputs)
 Create a new sound filter with the specified number of audio inputs and outputs. More...
 
 SoundFilter (Size numInputs, Size numOutputs, Size numMIDIInputs, Size numMIDIOutputs)
 Create a new sound filter with the specified number of audio inputs and outputs. More...
 
void setInputCount (Size newNumInputs)
 Set the number of inputs that this filter should have. More...
 
void setOutputCount (Size newNumOutputs)
 Set the number of outputs that this filter should have. More...
 
void setMIDIInputCount (Size newNumMIDIInputs)
 Set the number of MIDI inputs that this filter should have. More...
 
void setMIDIOutputCount (Size newNumMIDIOutputs)
 Set the number of MIDI outputs that this filter should have. More...
 
Bool isFirstFrame () const
 Return whether or not the filter's next frame to be processed is also its first frame. More...
 
void lockMutex () const
 Acquire a mutex which handles subclass rendering parameter synchronization. More...
 
void unlockMutex () const
 Release a mutex which handles subclass rendering parameter synchronization. More...
 

Detailed Description

A class that provides a basic 5-band parametric EQ with additional high/low shelf/pass filters.

Constructor & Destructor Documentation

om::sound::filters::ParametricEqualizer::ParametricEqualizer ( )

Create a default parametric equalizer with 5 parametric filter bands.

Member Function Documentation

Gain om::sound::filters::ParametricEqualizer::getOutputGain ( ) const
inline

Return the linear output gain for this parametric equalizer.

Gain om::sound::filters::ParametricEqualizer::getOutputGainDB ( ) const
inline

Return the output gain in decibels for this parametric equalizer.

void om::sound::filters::ParametricEqualizer::setOutputGain ( Gain  newGain)
inline

Set the linear output gain for this parametric equalizer.

void om::sound::filters::ParametricEqualizer::setOutputGainDB ( Gain  newGain)
inline

Set the output gain in decibels for this parametric equalizer.

Size om::sound::filters::ParametricEqualizer::getParametricCount ( ) const
inline

Return the number of parametric EQ filters that make up this parametric equalizer.

void om::sound::filters::ParametricEqualizer::setParametricCount ( Size  newNumberOfParametrics)
inline

Set the number of parametric EQ filters that make up this parametric equalizer.

If the specified new number of parametric filters is less than the old number, the unnecessary filters are removed and deleted. If the new number is greater, the new frequency bands are initialzed to have the center frequency of 1000Hz.

Bool om::sound::filters::ParametricEqualizer::getParametricIsEnabled ( Index  parametricIndex) const
inline

Return whether or not the parametric filter within this equalizer at the specified index is enabled.

void om::sound::filters::ParametricEqualizer::setParametricIsEnabled ( Index  parametricIndex,
Bool  newIsEnabled 
)
inline

Set whether or not the parametric filter within this equalizer at the specified index is enabled.

Gain om::sound::filters::ParametricEqualizer::getParametricGain ( Index  parametricIndex) const
inline

Return the linear gain of the parametric filter within this equalizer at the specified index.

Gain om::sound::filters::ParametricEqualizer::getParametricGainDB ( Index  parametricIndex) const
inline

Return the gain in decibels of the parametric filter within this equalizer at the specified index.

void om::sound::filters::ParametricEqualizer::setParametricGain ( Index  parametricIndex,
Gain  newGain 
)
inline

Set the linear gain of the parametric filter within this equalizer at the specified index.

void om::sound::filters::ParametricEqualizer::setParametricGainDB ( Index  parametricIndex,
Gain  newGain 
)
inline

Set the gain in decibels of the parametric filter within this equalizer at the specified index.

Float om::sound::filters::ParametricEqualizer::getParametricFrequency ( Index  parametricIndex) const
inline

Return the center frequency of the parametric filter within this equalizer at the specified index.

void om::sound::filters::ParametricEqualizer::setParametricFrequency ( Index  parametricIndex,
Float  newFrequency 
)
inline

Set the center frequency of the parametric filter within this equalizer at the specified index.

Float om::sound::filters::ParametricEqualizer::getParametricQ ( Index  parametricIndex) const
inline

Return the Q factor of the parametric filter within this equalizer at the specified index.

void om::sound::filters::ParametricEqualizer::setParametricQ ( Index  parametricIndex,
Float  newQ 
)
inline

Set the Q factor of the parametric filter within this equalizer at the specified index.

Float om::sound::filters::ParametricEqualizer::getParametricBandwidth ( Index  parametricIndex) const
inline

Return the bandwidth in octaves of the parametric filter within this equalizer at the specified index.

void om::sound::filters::ParametricEqualizer::setParametricBandwidth ( Index  parametricIndex,
Float  newBandwidth 
)
inline

Set the bandwidth in octaves of the parametric filter within this equalizer at the specified index.

Float om::sound::filters::ParametricEqualizer::getHighPassFrequency ( ) const
inline

Return the corner frequency of this parametric equalizer's high pass filter.

void om::sound::filters::ParametricEqualizer::setHighPassFrequency ( Float  newFrequency)
inline

Set the corner frequency of this parametric equalizer's high pass filter.

Size om::sound::filters::ParametricEqualizer::getHighPassOrder ( ) const
inline

Return the order of this parametric equalizer's high pass filter.

void om::sound::filters::ParametricEqualizer::setHighPassOrder ( Size  newOrder)
inline

Set the order of this parametric equalizer's high pass filter.

Bool om::sound::filters::ParametricEqualizer::getHighPassIsEnabled ( ) const
inline

Return whether or not the high pass filter of this parametric equalizer is enabled.

void om::sound::filters::ParametricEqualizer::setHighPassIsEnabled ( Bool  newIsEnabled)
inline

Set whether or not the high pass filter of this parametric equalizer is enabled.

Float om::sound::filters::ParametricEqualizer::getLowPassFrequency ( ) const
inline

Return the corner frequency of this parametric equalizer's low pass filter.

void om::sound::filters::ParametricEqualizer::setLowPassFrequency ( Float  newFrequency)
inline

Set the corner frequency of this parametric equalizer's low pass filter.

Size om::sound::filters::ParametricEqualizer::getLowPassOrder ( ) const
inline

Return the order of this parametric equalizer's low pass filter.

void om::sound::filters::ParametricEqualizer::setLowPassOrder ( Size  newOrder)
inline

Set the order of this parametric equalizer's low pass filter.

Bool om::sound::filters::ParametricEqualizer::getLowPassIsEnabled ( ) const
inline

Return whether or not the low pass filter of this parametric equalizer is enabled.

void om::sound::filters::ParametricEqualizer::setLowPassIsEnabled ( Bool  newIsEnabled)
inline

Set whether or not the low pass filter of this parametric equalizer is enabled.

Float om::sound::filters::ParametricEqualizer::getLowShelfFrequency ( ) const
inline

Return the corner frequency of this parametric equalizer's low shelf filter.

void om::sound::filters::ParametricEqualizer::setLowShelfFrequency ( Float  newFrequency)
inline

Set the corner frequency of this parametric equalizer's low shelf filter.

Gain om::sound::filters::ParametricEqualizer::getLowShelfGain ( ) const
inline

Return the linear gain of this parametric equalizer's low shelf filter.

Gain om::sound::filters::ParametricEqualizer::getLowShelfGainDB ( ) const
inline

Return the gain in decibels of this parametric equalizer's low shelf filter.

void om::sound::filters::ParametricEqualizer::setLowShelfGain ( Gain  newGain)
inline

Set the linear gain of this parametric equalizer's low shelf filter.

void om::sound::filters::ParametricEqualizer::setLowShelfGainDB ( Gain  newGain)
inline

Set the gain in decibels of this parametric equalizer's low shelf filter.

Float om::sound::filters::ParametricEqualizer::getLowShelfSlope ( ) const
inline

Return the slope of this parametric equalizer's low shelf filter.

void om::sound::filters::ParametricEqualizer::setLowShelfSlope ( Float  newSlope)
inline

Set the slope of this parametric equalizer's low shelf filter.

Bool om::sound::filters::ParametricEqualizer::getLowShelfIsEnabled ( ) const
inline

Return whether or not the low shelf filter of this parametric equalizer is enabled.

void om::sound::filters::ParametricEqualizer::setLowShelfIsEnabled ( Bool  newIsEnabled)
inline

Set whether or not the low shelf filter of this parametric equalizer is enabled.

Float om::sound::filters::ParametricEqualizer::getHighShelfFrequency ( ) const
inline

Return the corner frequency of this parametric equalizer's high shelf filter.

void om::sound::filters::ParametricEqualizer::setHighShelfFrequency ( Float  newFrequency)
inline

Set the corner frequency of this parametric equalizer's high shelf filter.

Gain om::sound::filters::ParametricEqualizer::getHighShelfGain ( ) const
inline

Return the linear gain of this parametric equalizer's high shelf filter.

Gain om::sound::filters::ParametricEqualizer::getHighShelfGainDB ( ) const
inline

Return the gain in decibels of this parametric equalizer's high shelf filter.

void om::sound::filters::ParametricEqualizer::setHighShelfGain ( Gain  newGain)
inline

Set the linear gain of this parametric equalizer's high shelf filter.

void om::sound::filters::ParametricEqualizer::setHighShelfGainDB ( Gain  newGain)
inline

Set the gain in decibels of this parametric equalizer's high shelf filter.

Float om::sound::filters::ParametricEqualizer::getHighShelfSlope ( ) const
inline

Return the slope of this parametric equalizer's high shelf filter.

void om::sound::filters::ParametricEqualizer::setHighShelfSlope ( Float  newSlope)
inline

Set the slope of this parametric equalizer's high shelf filter.

Bool om::sound::filters::ParametricEqualizer::getHighShelfIsEnabled ( ) const
inline

Return whether or not the high shelf filter of this parametric equalizer is enabled.

void om::sound::filters::ParametricEqualizer::setHighShelfIsEnabled ( Bool  newIsEnabled)
inline

Set whether or not the high shelf filter of this parametric equalizer is enabled.

virtual UTF8String om::sound::filters::ParametricEqualizer::getName ( ) const
virtual

Return a human-readable name for this parametric equalizer.

The method returns the string "Parametric Equalizer".

Reimplemented from om::sound::filters::SoundFilter.

virtual UTF8String om::sound::filters::ParametricEqualizer::getManufacturer ( ) const
virtual

Return the manufacturer name of this parametric equalizer.

The method returns the string "Om Sound".

Reimplemented from om::sound::filters::SoundFilter.

virtual FilterVersion om::sound::filters::ParametricEqualizer::getVersion ( ) const
virtual

Return an object representing the version of this parametric equalizer.

Reimplemented from om::sound::filters::SoundFilter.

virtual FilterCategory om::sound::filters::ParametricEqualizer::getCategory ( ) const
virtual

Return an object that describes the category of effect that this filter implements.

This method returns the value FilterCategory::EQUALIZER.

Reimplemented from om::sound::filters::SoundFilter.

virtual Bool om::sound::filters::ParametricEqualizer::allowsInPlaceProcessing ( ) const
virtual

Return whether or not this parametric equalizer can process audio data in-place.

This method always returns TRUE, parameteric equalizers can process audio data in-place.

Reimplemented from om::sound::filters::SoundFilter.

virtual Size om::sound::filters::ParametricEqualizer::getParameterCount ( ) const
virtual

Return the total number of generic accessible parameters this filter has.

Reimplemented from om::sound::filters::SoundFilter.

virtual Bool om::sound::filters::ParametricEqualizer::getParameterInfo ( Index  parameterIndex,
FilterParameterInfo info 
) const
virtual

Get information about the parameter at the specified index.

Reimplemented from om::sound::filters::SoundFilter.

Member Data Documentation

const UTF8String om::sound::filters::ParametricEqualizer::NAME
static

A string indicating the human-readable name of this parametric equalizer.

const UTF8String om::sound::filters::ParametricEqualizer::MANUFACTURER
static

A string indicating the manufacturer name of this parametric equalizer.

const FilterVersion om::sound::filters::ParametricEqualizer::VERSION
static

An object indicating the version of this parametric equalizer.


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