org.jouvieje.fmodex.enumerations
Class FMOD_DSP_COMPRESSOR

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

All Implemented Interfaces:

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

public class FMOD_DSP_COMPRESSOR

extends java.lang.Object

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

Parameter types for the FMOD_DSP_TYPE_COMPRESSOR unit.
This is a simple linked multichannel software limiter that is uniform across the whole spectrum.

Remarks

The limiter is not guaranteed to catch every peak above the threshold level,
because it cannot apply gain reduction instantaneously - the time delay is
determined by the attack time. However setting the attack time too short will
distort the sound, so it is a compromise. High level peaks can be avoided by
using a short attack time - but not too short, and setting the threshold a few
decibels below the critical level.

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
System::addDSP

Field Summary

static FMOD_DSP_COMPRESSOR	FMOD_DSP_COMPRESSOR_ATTACK
static FMOD_DSP_COMPRESSOR	FMOD_DSP_COMPRESSOR_GAINMAKEUP
static FMOD_DSP_COMPRESSOR	FMOD_DSP_COMPRESSOR_RELEASE
static FMOD_DSP_COMPRESSOR	FMOD_DSP_COMPRESSOR_THRESHOLD

Method Summary

int	asInt()
int	compareTo(java.lang.Object object)
boolean	equals(java.lang.Object object)
static FMOD_DSP_COMPRESSOR	get(int nativeValue) Retrieve a FMOD_DSP_COMPRESSOR enum field with his integer value
static FMOD_DSP_COMPRESSOR	get(Pointer pointer) Retrieve a FMOD_DSP_COMPRESSOR 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_COMPRESSOR_THRESHOLD

public static final FMOD_DSP_COMPRESSOR FMOD_DSP_COMPRESSOR_THRESHOLD

FMOD_DSP_COMPRESSOR_ATTACK

public static final FMOD_DSP_COMPRESSOR FMOD_DSP_COMPRESSOR_ATTACK

FMOD_DSP_COMPRESSOR_RELEASE

public static final FMOD_DSP_COMPRESSOR FMOD_DSP_COMPRESSOR_RELEASE

FMOD_DSP_COMPRESSOR_GAINMAKEUP

public static final FMOD_DSP_COMPRESSOR FMOD_DSP_COMPRESSOR_GAINMAKEUP

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_COMPRESSOR get(int nativeValue)

Retrieve a FMOD_DSP_COMPRESSOR enum field with his integer value

Parameters:

nativeValue - the integer value of the field to retrieve

Returns:

the FMOD_DSP_COMPRESSOR enum field that correspond to the integer value

get

public static FMOD_DSP_COMPRESSOR get(Pointer pointer)

Retrieve a FMOD_DSP_COMPRESSOR enum field from a Pointer

Parameters:

pointer - a pointer holding an FMOD_DSP_COMPRESSOR enum field

Returns:

the FMOD_DSP_COMPRESSOR 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.