om::sound::filters::FilterCategory Class Reference

A class that represents the kind of effect that a SoundFilter performs. More...

#include <omSoundFilterCategory.h>

Public Types
enum	Enum {   OTHER = 0, PLAYBACK = 1, RECORDING = 2, INSTRUMENT = 3,   ROUTING = 4, IMAGING = 5, EQUALIZER = 6, DYNAMICS = 7,   DISTORTION = 8, DELAY = 9, REVERB = 10, MODULATION = 11,   PITCH = 12, MIDI = 13, ANALYSIS = 14, UTILITY = 15 }
	An enum that specifies the different SoundFilter categories. More...

Public Member Functions
	FilterCategory ()
	Create a new filter type object with the OTHER parameter type. More...
	FilterCategory (Enum newType)
	Create a new filter type object with the specified type enum value. More...
	operator Enum () const
	Convert this filter type to an enum value. More...
UTF8String	toString () const
	Return a string representation of the filter type. More...
	operator UTF8String () const
	Convert this filter type into a string representation. More...

Detailed Description

A class that represents the kind of effect that a SoundFilter performs.

This allows filters to report a category of effect which they belong to, and allows filter hosts to sort filters by their type.

Member Enumeration Documentation

enum om::sound::filters::FilterCategory::Enum

An enum that specifies the different SoundFilter categories.

Enumerator
OTHER	An undefined filter category, used when no other category fits.
PLAYBACK	A category where the filter produces output audio from an internal source, such as a file. This category can include samplers and any filter that plays back audio, like an audio file player, MIDI file player, etc.
RECORDING	A category where the filter records input audio to a destination, such as a file or looping buffer. This category can include filters that record audio to a file, record loops, or other similar operations.
INSTRUMENT	A category where the filter is used as a musical instrument, taking MIDI input data and producing output audio. This category can include synthesizers, virtual instruments, samplers, drum machines, etc.
ROUTING	A category where the filter is used to do some sort of routing function. This category can include mixers, splitters, channel strips, processing graphs, etc.
IMAGING	A category where the filter is used to manipulate channel directionality. This category can include panners, HRTF effects, directional mixers, and stereo utilities.
EQUALIZER	A category where the filter is used to modify the frequency response of audio. This category can include single IIR filters, multi-band equalizers, linear phase equalizers, crossovers, graphic equalizers, wah effects, etc.
DYNAMICS	A category where the filter is used to control the dynamic range of audio. This category can include compressors, gates, limiters, gain riders, simple gain controls, etc.
DISTORTION	A category where the filter is used to add some sort of distortion to the audio. This category can include overdrives, hard clipping effects, phase-based distortion, etc.
DELAY	A category where the filter is used to produce a delayed version of the audio. This category can include basic delays, stereo delays, etc.
REVERB	A category where the filter is used to produce a reverberant effect, used to model room acoustics. This category can include basic reverb effects, convolution reverb, and other reverb- based effects.
MODULATION	A category where the filter is used to modulate the audio in some way. This category can include amplitude modulation effects (tremolo, ring modulation), pitch moduation effects (vibrato, flanger, chorus, phase), and other similar effects.
PITCH	A category where the filter operates on the pitch information of the audio. This categeory can include pitch shifters, pitch correction, tuners, harmonizers, etc.
MIDI	A category where the filter operates on primarily MIDI data. This categeory can include MIDI delay, harmonizers, and other effects that process MIDI data.
ANALYSIS	A category where the filter is used to analyze the input audio. This category can include RTAs, tone generators, and other audio analysis tools.
UTILITY	A category where the filter is used to perform a low-level task that doesn't fit in another category. This category can include effects like sample rate conversion, convolution, phase controls, etc.

Constructor & Destructor Documentation

om::sound::filters::FilterCategory::FilterCategory ( )

inline

Create a new filter type object with the OTHER parameter type.

om::sound::filters::FilterCategory::FilterCategory ( Enum  newType )

inline

Create a new filter type object with the specified type enum value.

Member Function Documentation

om::sound::filters::FilterCategory::operator Enum ( ) const

inline

Convert this filter type to an enum value.

This operator is provided so that the FilterCategory object can be used directly in a switch statement without the need to explicitly access the underlying enum value.

Returns

the enum representation of this filter type.

UTF8String om::sound::filters::FilterCategory::toString

(

)

const

Return a string representation of the filter type.

om::sound::filters::FilterCategory::operator UTF8String ( ) const

inline

Convert this filter type into a string representation.

---

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

• omSoundFilterCategory.h