org.jouvieje.fmodex.enumerations
Class FMOD_DSP_ECHO

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

All Implemented Interfaces:

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

public class FMOD_DSP_ECHO

extends java.lang.Object

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

Parameter types for the FMOD_DSP_TYPE_ECHO filter.

Remarks

Note. Every time the delay is changed, the plugin re-allocates the echo buffer. This means the echo will dissapear at that time while it refills its new buffer.
Larger echo delays result in larger amounts of memory allocated.
'maxchannels' also dictates the amount of memory allocated. By default, the maxchannels value is 0. If FMOD is set to stereo, the echo unit will allocate enough memory for 2 channels. If it is 5.1, it will allocate enough memory for a 6 channel echo, etc.
If the echo effect is only ever applied to the global mix (ie it was added with System::addDSP), then 0 is the value to set as it will be enough to handle all speaker modes.
When the echo is added to a channel (ie Channel::addDSP) then the channel count that comes in could be anything from 1 to 8 possibly. It is only in this case where you might want to increase the channel count above the output's channel count.
If a channel echo is set to a lower number than the sound's channel count that is coming in, it will not echo the sound.

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_ECHO	FMOD_DSP_ECHO_DECAYRATIO
static FMOD_DSP_ECHO	FMOD_DSP_ECHO_DELAY
static FMOD_DSP_ECHO	FMOD_DSP_ECHO_DRYMIX
static FMOD_DSP_ECHO	FMOD_DSP_ECHO_MAXCHANNELS
static FMOD_DSP_ECHO	FMOD_DSP_ECHO_WETMIX

Method Summary

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

public static final FMOD_DSP_ECHO FMOD_DSP_ECHO_DELAY

FMOD_DSP_ECHO_DECAYRATIO

public static final FMOD_DSP_ECHO FMOD_DSP_ECHO_DECAYRATIO

FMOD_DSP_ECHO_MAXCHANNELS

public static final FMOD_DSP_ECHO FMOD_DSP_ECHO_MAXCHANNELS

FMOD_DSP_ECHO_DRYMIX

public static final FMOD_DSP_ECHO FMOD_DSP_ECHO_DRYMIX

FMOD_DSP_ECHO_WETMIX

public static final FMOD_DSP_ECHO FMOD_DSP_ECHO_WETMIX

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

Retrieve a FMOD_DSP_ECHO enum field with his integer value

Parameters:

nativeValue - the integer value of the field to retrieve

Returns:

the FMOD_DSP_ECHO enum field that correspond to the integer value

get

public static FMOD_DSP_ECHO get(Pointer pointer)

Retrieve a FMOD_DSP_ECHO enum field from a Pointer

Parameters:

pointer - a pointer holding an FMOD_DSP_ECHO enum field

Returns:

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