org.jouvieje.fmodex.enumerations
Class FMOD_DSP_TREMOLO

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

All Implemented Interfaces:

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

public class FMOD_DSP_TREMOLO

extends java.lang.Object

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

Parameter types for the FMOD_DSP_TYPE_TREMOLO filter.

Remarks

The tremolo effect varies the amplitude of a sound. Depending on the settings, this unit can produce a tremolo, chopper or auto-pan effect.
The shape of the LFO (low freq. oscillator) can morphed between sine, triangle and sawtooth waves using the FMOD_DSP_TREMOLO_SHAPE and FMOD_DSP_TREMOLO_SKEW parameters.
FMOD_DSP_TREMOLO_DUTY and FMOD_DSP_TREMOLO_SQUARE are useful for a chopper-type effect where the first controls the on-time duration and second controls the flatness of the envelope.
FMOD_DSP_TREMOLO_SPREAD varies the LFO phase between channels to get an auto-pan effect. This works best with a sine shape LFO.
The LFO can be synchronized using the FMOD_DSP_TREMOLO_PHASE parameter which sets its instantaneous phase.

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_TREMOLO	FMOD_DSP_TREMOLO_DEPTH
static FMOD_DSP_TREMOLO	FMOD_DSP_TREMOLO_DUTY
static FMOD_DSP_TREMOLO	FMOD_DSP_TREMOLO_FREQUENCY
static FMOD_DSP_TREMOLO	FMOD_DSP_TREMOLO_PHASE
static FMOD_DSP_TREMOLO	FMOD_DSP_TREMOLO_SHAPE
static FMOD_DSP_TREMOLO	FMOD_DSP_TREMOLO_SKEW
static FMOD_DSP_TREMOLO	FMOD_DSP_TREMOLO_SPREAD
static FMOD_DSP_TREMOLO	FMOD_DSP_TREMOLO_SQUARE

Method Summary

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

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_FREQUENCY

FMOD_DSP_TREMOLO_DEPTH

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_DEPTH

FMOD_DSP_TREMOLO_SHAPE

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_SHAPE

FMOD_DSP_TREMOLO_SKEW

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_SKEW

FMOD_DSP_TREMOLO_DUTY

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_DUTY

FMOD_DSP_TREMOLO_SQUARE

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_SQUARE

FMOD_DSP_TREMOLO_PHASE

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_PHASE

FMOD_DSP_TREMOLO_SPREAD

public static final FMOD_DSP_TREMOLO FMOD_DSP_TREMOLO_SPREAD

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

Retrieve a FMOD_DSP_TREMOLO enum field with his integer value

Parameters:

nativeValue - the integer value of the field to retrieve

Returns:

the FMOD_DSP_TREMOLO enum field that correspond to the integer value

get

public static FMOD_DSP_TREMOLO get(Pointer pointer)

Retrieve a FMOD_DSP_TREMOLO enum field from a Pointer

Parameters:

pointer - a pointer holding an FMOD_DSP_TREMOLO enum field

Returns:

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