org.jouvieje.fmodex.enumerations
Class FMOD_DSP_CHORUS

java.lang.Object
  extended byorg.jouvieje.fmodex.enumerations.FMOD_DSP_CHORUS
All Implemented Interfaces:
java.lang.Comparable, org.jouvieje.fmodex.enumerations.Enumeration

public class FMOD_DSP_CHORUS
extends java.lang.Object
implements org.jouvieje.fmodex.enumerations.Enumeration, java.lang.Comparable



Parameter types for the FMOD_DSP_TYPE_CHORUS filter.

Remarks

Chrous is an effect where the sound is more 'spacious' due to 1 to 3 versions of the sound being played along side the original signal but with the pitch of each copy modulating on a sine wave.
This is a highly configurable chorus unit. It supports 3 taps, small and large delay times and also feedback.
This unit also could be used to do a simple echo, or a flange effect.

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_CHORUS FMOD_DSP_CHORUS_DELAY
           
static FMOD_DSP_CHORUS FMOD_DSP_CHORUS_DEPTH
           
static FMOD_DSP_CHORUS FMOD_DSP_CHORUS_DRYMIX
           
static FMOD_DSP_CHORUS FMOD_DSP_CHORUS_FEEDBACK
           
static FMOD_DSP_CHORUS FMOD_DSP_CHORUS_RATE
           
static FMOD_DSP_CHORUS FMOD_DSP_CHORUS_WETMIX1
           
static FMOD_DSP_CHORUS FMOD_DSP_CHORUS_WETMIX2
           
static FMOD_DSP_CHORUS FMOD_DSP_CHORUS_WETMIX3
           
 
Method Summary
 int asInt()
           
 int compareTo(java.lang.Object object)
           
 boolean equals(java.lang.Object object)
           
static FMOD_DSP_CHORUS get(int nativeValue)
          Retrieve a FMOD_DSP_CHORUS enum field with his integer value
static FMOD_DSP_CHORUS get(Pointer pointer)
          Retrieve a FMOD_DSP_CHORUS 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_CHORUS_DRYMIX

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_DRYMIX

FMOD_DSP_CHORUS_WETMIX1

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_WETMIX1

FMOD_DSP_CHORUS_WETMIX2

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_WETMIX2

FMOD_DSP_CHORUS_WETMIX3

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_WETMIX3

FMOD_DSP_CHORUS_DELAY

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_DELAY

FMOD_DSP_CHORUS_RATE

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_RATE

FMOD_DSP_CHORUS_DEPTH

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_DEPTH

FMOD_DSP_CHORUS_FEEDBACK

public static final FMOD_DSP_CHORUS FMOD_DSP_CHORUS_FEEDBACK
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_CHORUS get(int nativeValue)
Retrieve a FMOD_DSP_CHORUS enum field with his integer value

Parameters:
nativeValue - the integer value of the field to retrieve
Returns:
the FMOD_DSP_CHORUS enum field that correspond to the integer value

get

public static FMOD_DSP_CHORUS get(Pointer pointer)
Retrieve a FMOD_DSP_CHORUS enum field from a Pointer

Parameters:
pointer - a pointer holding an FMOD_DSP_CHORUS enum field
Returns:
the FMOD_DSP_CHORUS 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.


NativeFmodEx Project - © Copyright 2005-2010 - Jérôme Jouvie (Jouvieje)
NativeFmodEx is an Open Source Project under GNU LGPL License
My sites : http://jerome.jouvie.free.fr/

(Documentation Copyright © Firelight Technologies - FMOD Ex - http://www.fmod.org)