com.jme.sound.fmod.scene
Class Configuration

java.lang.Object
  com.jme.sound.fmod.scene.Configuration

public class Configuration

extends java.lang.Object

Field Summary

static int	FX_CHORUS
static int	FX_COMPRESSOR
static int	FX_DISTORTION
static int	FX_ECHO
static int	FX_FLANGER
static int	FX_GARGLE
static int	FX_I3DL2REVERB
static int	FX_MAX
static int	FX_PARAMEQ
static int	FX_WAVES_REVERB

Constructor Summary

Configuration()

Method Summary

float[]	getChorusParams()
float[]	getCompressorParams()
float[]	getDistorsionParams()
float[]	getEchoParams()
float[]	getEqParams()
float[]	getFlangerParams()
float[]	getGargleParams()
float[]	getI3DLParams()
float[]	getReverbParams()
boolean	isChorusEnabled()
boolean	isCompressorEnabled()
boolean	isDistorsionEnabled()
boolean	isEchoEnabled()
boolean	isEqEnabled()
boolean	isFlangerEnabled()
boolean	isFxEnabled()
boolean	isGargleEnabled()
boolean	isI3DL2ReverbEnabled()
boolean	isMaxEnabled()
boolean	isReverbEnabled()
void	setChorus(float WetDryMix, float Depth, float Feedback, float Frequency, int Waveform, float Delay, int Phase) Fx chorus configuration params.
void	setCompressor(float Gain, float Attack, float Release, float Threshold, float Ratio, float Predelay)
void	setDistortion(float Gain, float Edge, float PostEQCenterFrequency, float PostEQBandwidth, float PreLowpassCutoff)
void	setEcho(float WetDryMix, float Feedback, float LeftDelay, float RightDelay, int PanDelay)
void	setEqParam(float Center, float Bandwidth, float Gain)
void	setFlanger(float WetDryMix, float Depth, float Feedback, float Frequency, int Waveform, float Delay, int Phase)
void	setGargle(int RateHz, int WaveShape)
void	setI3DL2Reverb(int Room, int RoomHF, float RoomRolloffFactor, float DecayTime, float DecayHFRatio, int Reflections, float ReflectionsDelay, int Reverb, float ReverbDelay, float Diffusion, float Density, float HFReference)
void	setReverb(float InGain, float ReverbMix, float ReverbTime, float HighFreqRTRatio)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FX_CHORUS

public static final int FX_CHORUS

See Also:

Constant Field Values

FX_COMPRESSOR

public static final int FX_COMPRESSOR

See Also:

Constant Field Values

FX_DISTORTION

public static final int FX_DISTORTION

See Also:

Constant Field Values

FX_ECHO

public static final int FX_ECHO

See Also:

Constant Field Values

FX_FLANGER

public static final int FX_FLANGER

See Also:

Constant Field Values

FX_GARGLE

public static final int FX_GARGLE

See Also:

Constant Field Values

FX_I3DL2REVERB

public static final int FX_I3DL2REVERB

See Also:

Constant Field Values

FX_PARAMEQ

public static final int FX_PARAMEQ

See Also:

Constant Field Values

FX_WAVES_REVERB

public static final int FX_WAVES_REVERB

See Also:

Constant Field Values

FX_MAX

public static final int FX_MAX

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration()

Method Detail

isFxEnabled

public boolean isFxEnabled()

isChorusEnabled

public boolean isChorusEnabled()

isCompressorEnabled

public boolean isCompressorEnabled()

isDistorsionEnabled

public boolean isDistorsionEnabled()

isEchoEnabled

public boolean isEchoEnabled()

isEqEnabled

public boolean isEqEnabled()

isFlangerEnabled

public boolean isFlangerEnabled()

isGargleEnabled

public boolean isGargleEnabled()

isI3DL2ReverbEnabled

public boolean isI3DL2ReverbEnabled()

isMaxEnabled

public boolean isMaxEnabled()

isReverbEnabled

public boolean isReverbEnabled()

setChorus

public void setChorus(float WetDryMix,
                      float Depth,
                      float Feedback,
                      float Frequency,
                      int Waveform,
                      float Delay,
                      int Phase)

Fx chorus configuration params. Setting those values will automatically enable fx on the sample or stream

Parameters:

WetDryMix - Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet).

Depth - Percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25.

Feedback - Percentage of output signal to feed back into the effects input, in the range from -99 to 99. The default value is 0.

Frequency - Frequency of the LFO, in the range from 0 to 10. The default value is 0. *

Waveform - Waveform - Waveform of the LFO. Defined values are 0 triangle. 1 sine. By default, the waveform is a sine.

Delay - Number of milliseconds the input is delayed before it is played back, in the range from 0 to 20. The default value is 0 ms

Phase - Phase differential between left and right LFOs, in the range from 0 through 4. Possible values are defined as follows: 0 -180 degrees 1 - 90 degrees 2 0 degrees 3 90 degrees 4 180 degrees

setEcho

public void setEcho(float WetDryMix,
                    float Feedback,
                    float LeftDelay,
                    float RightDelay,
                    int PanDelay)

Parameters:

WetDryMix - Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet).

Feedback - Percentage of output fed back into input, in the range from 0 through 100. The default value is 0.

LeftDelay - Delay for left channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms

RightDelay - Delay for right channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.

PanDelay - Value that specifies whether to swap left and right delays with each successive echo. The default value is FALSE, meaning no swap. Possible values are defined as TRUE or FALSE.

setCompressor

public void setCompressor(float Gain,
                          float Attack,
                          float Release,
                          float Threshold,
                          float Ratio,
                          float Predelay)

Parameters:

Gain - Output gain of signal after compression, in the range from -60 to 60. The default value is 0 dB.

Attack - Time before compression reaches its full value, in the range from 0.01 to 500. The default value is 0.01 ms.

Release - Speed at which compression is stopped after input drops below fThreshold, in the range from 50 to 3000. The default value is 50 ms.

Threshold - Point at which compression begins, in decibels, in the range from -60 to 0. The default value is -10 dB

Ratio - Compression ratio, in the range from 1 to 100. The default value is 10, which means 10:1 compression.

Predelay - Time after lThreshold is reached before attack phase is started, in milliseconds, in the range from 0 to 4. The default value is 0 ms.

setDistortion

public void setDistortion(float Gain,
                          float Edge,
                          float PostEQCenterFrequency,
                          float PostEQBandwidth,
                          float PreLowpassCutoff)

Parameters:

Gain - Amount of signal change after distortion, in the range from -60 through 0. The default value is 0 dB.

Edge - Percentage of distortion intensity, in the range in the range from 0 through 100. The default value is 50 percent

PostEQCenterFrequency - Center frequency of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz

PostEQBandwidth - Width of frequency band that determines range of harmonic content addition, in the range from 100 through 8000. The default value is 4000 Hz.

PreLowpassCutoff - Filter cutoff for high-frequency harmonics attenuation, in the range from 100 through 8000. The default value is 4000 Hz

setFlanger

public void setFlanger(float WetDryMix,
                       float Depth,
                       float Feedback,
                       float Frequency,
                       int Waveform,
                       float Delay,
                       int Phase)

Parameters:

WetDryMix - Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet).

Depth - Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25.

Feedback - Feedback - Percentage of output signal to feed back into the effects input, in the range from -99 to 99. The default value is 0.

Frequency - Frequency of the LFO, in the range from 0 to 10. The default value is 0.

Waveform - Waveform of the LFO. By default, the waveform is a sine. Possible values are defined as follows: 0 - Triangle. 1 - Sine.

Delay - Number of milliseconds the input is delayed before it is played back, in the range from 0 to 4. The default value is 0 ms

Phase - Phase differential between left and right LFOs, in the range from 0 through 4. Possible values are defined as follows: 0 -180 degrees 1 - 90 degrees 2 0 degrees 3 90 degrees 4 180 degrees

setGargle

public void setGargle(int RateHz,
                      int WaveShape)

Parameters:

RateHz - Rate of modulation, in Hertz. Must be in the range from 1 through 1000

WaveShape - Shape of the modulation wave. The following values are defined. 0 - Triangular wave. 1 - Square wave.

setI3DL2Reverb

public void setI3DL2Reverb(int Room,
                           int RoomHF,
                           float RoomRolloffFactor,
                           float DecayTime,
                           float DecayHFRatio,
                           int Reflections,
                           float ReflectionsDelay,
                           int Reverb,
                           float ReverbDelay,
                           float Diffusion,
                           float Density,
                           float HFReference)

Parameters:

Room - Attenuation of the room effect, in millibels (mB), in the range from -10000 to 0. The default value is -1000 mB.

RoomHF - Attenuation of the room high-frequency effect, in mB, in the range from -10000 to 0. The default value is 0 mB

RoomRolloffFactor - Rolloff factor for the reflected signals, in the range from 0 to 10. The default value is 0.0. The rolloff factor for the direct path is controlled by the listener

DecayTime - Decay time, in seconds, in the range from .1 to 20. The default value is 1.49 seconds.

DecayHFRatio - Ratio of the decay time at high frequencies to the decay time at low frequencies, in the range from 0.1 to 2. The default value is 0.83

Reflections - Attenuation of early reflections relative to lRoom, in mB, in the range from -10000 to 1000. The default value is -2602 mB

ReflectionsDelay - Delay time of the first reflection relative to the direct path, in seconds, in the range from 0 to 0.3. The default value is 0.007 seconds

Reverb - Attenuation of late reverberation relative to lRoom, in mB, in the range from -10000 to 2000. The default value is 200 mB

ReverbDelay - Time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds, in the range from 0 to 0.1. The default value is 0.011 seconds

Diffusion - Echo density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent

Density - Modal density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent

HFReference - Reference high frequency, in hertz, in the range from 20 to 20000. The default value is 5000.0 Hz

setEqParam

public void setEqParam(float Center,
                       float Bandwidth,
                       float Gain)

Parameters:

Center - Center frequency, in hertz, in the range from 80 to 16000. This value cannot exceed one-third of the frequency of the buffer. Default is 8000

Bandwidth - Bandwidth, in semitones, in the range from 1 to 36. Default is 12

Gain - Gain, in the range from -15 to 15. Default is 0.

setReverb

public void setReverb(float InGain,
                      float ReverbMix,
                      float ReverbTime,
                      float HighFreqRTRatio)

Parameters:

InGain - Input gain of signal, in decibels (dB), in the range from -96 through 0. The default value is 0 dB.

ReverbMix - Reverb mix, in dB, in the range from -96 through 0. The default value is 0 dB.

ReverbTime - Reverb time, in milliseconds, in the range from .001 through 3000. The default value is 1000.

HighFreqRTRatio - In the range from .001 through .999. The default value is 0.001

getChorusParams

public float[] getChorusParams()

getCompressorParams

public float[] getCompressorParams()

getDistorsionParams

public float[] getDistorsionParams()

getEchoParams

public float[] getEchoParams()

getFlangerParams

public float[] getFlangerParams()

getGargleParams

public float[] getGargleParams()

getI3DLParams

public float[] getI3DLParams()

getEqParams

public float[] getEqParams()

getReverbParams

public float[] getReverbParams()