org.jouvieje.fmodex.enumerations
Class FMOD_DSP_PARAMEQ

java.lang.Object
  org.jouvieje.fmodex.enumerations.FMOD_DSP_PARAMEQ

All Implemented Interfaces:

java.lang.Comparable, org.jouvieje.fmodex.enumerations.Enumeration

public class FMOD_DSP_PARAMEQ

extends java.lang.Object

implements org.jouvieje.fmodex.enumerations.Enumeration, java.lang.Comparable

Parameter types for the FMOD_DSP_TYPE_PARAMEQ filter.

Remarks

Parametric EQ is a bandpass filter that attenuates or amplifies a selected frequency and its neighbouring frequencies.
To create a multi-band EQ create multiple FMOD_DSP_TYPE_PARAMEQ units and set each unit to different frequencies, for example 1000hz, 2000hz, 4000hz, 8000hz, 16000hz with a range of 1 octave each.
When a frequency has its gain set to 1.0, the sound will be unaffected and represents the original signal exactly.

Platforms Supported

Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation 2, PlayStation Portable, PlayStation 3, Wii, Solaris, iPhone

See Also

DSP::setParameter
DSP::getParameter
FMOD_DSP_TYPE

Field Summary

static FMOD_DSP_PARAMEQ	FMOD_DSP_PARAMEQ_BANDWIDTH
static FMOD_DSP_PARAMEQ	FMOD_DSP_PARAMEQ_CENTER
static FMOD_DSP_PARAMEQ	FMOD_DSP_PARAMEQ_GAIN

Method Summary

int	asInt()
int	compareTo(java.lang.Object object)
boolean	equals(java.lang.Object object)
static FMOD_DSP_PARAMEQ	get(int nativeValue) Retrieve a FMOD_DSP_PARAMEQ enum field with his integer value
static FMOD_DSP_PARAMEQ	get(Pointer pointer) Retrieve a FMOD_DSP_PARAMEQ enum field from a Pointer
static java.util.Iterator	iterator()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FMOD_DSP_PARAMEQ_CENTER

public static final FMOD_DSP_PARAMEQ FMOD_DSP_PARAMEQ_CENTER

FMOD_DSP_PARAMEQ_BANDWIDTH

public static final FMOD_DSP_PARAMEQ FMOD_DSP_PARAMEQ_BANDWIDTH

FMOD_DSP_PARAMEQ_GAIN

public static final FMOD_DSP_PARAMEQ FMOD_DSP_PARAMEQ_GAIN

Method Detail

asInt

public int asInt()

Specified by:

asInt in interface org.jouvieje.fmodex.enumerations.Enumeration

Returns:

the integer value of the enumeration constant.

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object object)

compareTo

public int compareTo(java.lang.Object object)

Specified by:

compareTo in interface java.lang.Comparable

get

public static FMOD_DSP_PARAMEQ get(int nativeValue)

Retrieve a FMOD_DSP_PARAMEQ enum field with his integer value

Parameters:

nativeValue - the integer value of the field to retrieve

Returns:

the FMOD_DSP_PARAMEQ enum field that correspond to the integer value

get

public static FMOD_DSP_PARAMEQ get(Pointer pointer)

Retrieve a FMOD_DSP_PARAMEQ enum field from a Pointer

Parameters:

pointer - a pointer holding an FMOD_DSP_PARAMEQ enum field

Returns:

the FMOD_DSP_PARAMEQ enum field that correspond to the enum field in the pointer

iterator

public static java.util.Iterator iterator()

Returns:

an Iterator over the elements in this enumeration.
Can be cast to Iterator in Java 1.5.