org.jouvieje.fmodex.structures
Class FMOD_REVERB_PROPERTIES

java.lang.Object
  org.jouvieje.fmodex.utils.Pointer
      org.jouvieje.fmodex.structures.FMOD_REVERB_PROPERTIES

public class FMOD_REVERB_PROPERTIES

extends Pointer

Constructor Summary

FMOD_REVERB_PROPERTIES()
Create an object that holds a null FMOD_REVERB_PROPERTIES.

Method Summary

static FMOD_REVERB_PROPERTIES	allocate() Allocate a new FMOD_REVERB_PROPERTIES.
static FMOD_REVERB_PROPERTIES	asFMOD_REVERB_PROPERTIES(Pointer pointer) Create a view of the Pointer object as a FMOD_REVERB_PROPERTIES object.
static FMOD_REVERB_PROPERTIES	create(int preset) Create an FMOD_REVERB_PROPERTIES using a preset FMOD_REVERB_PRESETS.
float	getAirAbsorptionHF() [r/w] -100 , 0.0 , -5.0 , change in level per meter at high frequencies (SUPPORTED:EAX)
float	getDecayHFRatio() [r/w] 0.1 , 2.0 , 0.83 , high-frequency to mid-frequency decay time ratio (SUPPORTED:EAX/I3DL2/SFX)
float	getDecayLFRatio() [r/w] 0.1 , 2.0 , 1.0 , low-frequency to mid-frequency decay time ratio (SUPPORTED:EAX)
float	getDecayTime() [r/w] 0.1 , 20.0 , 1.49 , reverberation decay time at mid frequencies (SUPPORTED:EAX/I3DL2/SFX)
float	getDensity() [r/w] 0.0 , 100.0 , 100.0 , Value that controls the modal density in the late reverberation decay (SUPPORTED:I3DL2/SFX)
float	getDiffusion() [r/w] 0.0 , 100.0 , 100.0 , Value that controls the echo density in the late reverberation decay.
float	getEchoDepth() [r/w] 0.0 , 1.0 , 0.0 , echo depth (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO only)
float	getEchoTime() [r/w] .075 , 0.25 , 0.25 , echo time (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO/FMOD_PRESET_PS2_DELAY only)
float	getEnvDiffusion() [r/w] 0.0 , 1.0 , 1.0 , environment diffusion (SUPPORTED:EAX)
int	getEnvironment() [r/w] -1 , 25 , -1 , sets all listener properties
float	getEnvSize() [r/w] 1.0 , 100.0 , 7.5 , environment size in meters (SUPPORTED:EAX)
int	getFlags() [r/w] FMOD_REVERB_FLAGS - modifies the behavior of above properties (SUPPORTED:EAX/PS2/WII)
float	getHFReference() [r/w] 1000.0, 20000 , 5000.0 , reference high frequency (hz) (SUPPORTED:EAX/I3DL2/SFX)
int	getInstance() [w] 0 , 3 , 0 , Environment Instance.
float	getLFReference() [r/w] 20.0 , 1000.0, 250.0 , reference low frequency (hz) (SUPPORTED:EAX/SFX)
float	getModulationDepth() [r/w] 0.0 , 1.0 , 0.0 , modulation depth (SUPPORTED:EAX)
float	getModulationTime() [r/w] 0.04 , 4.0 , 0.25 , modulation time (SUPPORTED:EAX)
int	getReflections() [r/w] -10000, 1000 , -2602 , early reflections level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)
float	getReflectionsDelay() [r/w] 0.0 , 0.3 , 0.007 , initial reflection delay time (SUPPORTED:EAX/I3DL2/SFX)
java.nio.FloatBuffer	getReflectionsPan() [r/w] , , [0,0,0], early reflections panning vector (SUPPORTED:EAX)
int	getReverb() [r/w] -10000, 2000 , 200 , late reverberation level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)
float	getReverbDelay() [r/w] 0.0 , 0.1 , 0.011 , late reverberation delay time relative to initial reflection (SUPPORTED:EAX/I3DL2/SFX)
java.nio.FloatBuffer	getReverbPan() [r/w] , , [0,0,0], late reverberation panning vector (SUPPORTED:EAX)
int	getRoom() [r/w] -10000, 0 , -1000 , room effect level (at mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)
int	getRoomHF() [r/w] -10000, 0 , -100 , relative room effect level at high frequencies (SUPPORTED:EAX/I3DL2/SFX)
int	getRoomLF() [r/w] -10000, 0 , 0 , relative room effect level at low frequencies (SUPPORTED:EAX/SFX)
float	getRoomRolloffFactor() [r/w] 0.0 , 10.0 , 0.0 , like rolloffscale in System::set3DSettings but for reverb room size effect (SUPPORTED:EAX/I3DL2)
void	release()
void	setAirAbsorptionHF(float airAbsorptionHF) [r/w] -100 , 0.0 , -5.0 , change in level per meter at high frequencies (SUPPORTED:EAX)
void	setDecayHFRatio(float decayHFRatio) [r/w] 0.1 , 2.0 , 0.83 , high-frequency to mid-frequency decay time ratio (SUPPORTED:EAX/I3DL2/SFX)
void	setDecayLFRatio(float decayLFRatio) [r/w] 0.1 , 2.0 , 1.0 , low-frequency to mid-frequency decay time ratio (SUPPORTED:EAX)
void	setDecayTime(float decayTime) [r/w] 0.1 , 20.0 , 1.49 , reverberation decay time at mid frequencies (SUPPORTED:EAX/I3DL2/SFX)
void	setDensity(float density) [r/w] 0.0 , 100.0 , 100.0 , Value that controls the modal density in the late reverberation decay (SUPPORTED:I3DL2/SFX)
void	setDiffusion(float diffusion) [r/w] 0.0 , 100.0 , 100.0 , Value that controls the echo density in the late reverberation decay.
void	setEchoDepth(float echoDepth) [r/w] 0.0 , 1.0 , 0.0 , echo depth (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO only)
void	setEchoTime(float echoTime) [r/w] .075 , 0.25 , 0.25 , echo time (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO/FMOD_PRESET_PS2_DELAY only)
void	setEnvDiffusion(float envDiffusion) [r/w] 0.0 , 1.0 , 1.0 , environment diffusion (SUPPORTED:EAX)
void	setEnvironment(int environment) [r/w] -1 , 25 , -1 , sets all listener properties
void	setEnvSize(float envSize) [r/w] 1.0 , 100.0 , 7.5 , environment size in meters (SUPPORTED:EAX)
void	setFlags(int flags) [r/w] FMOD_REVERB_FLAGS - modifies the behavior of above properties (SUPPORTED:EAX/PS2/WII)
void	setHFReference(float HFReference) [r/w] 1000.0, 20000 , 5000.0 , reference high frequency (hz) (SUPPORTED:EAX/I3DL2/SFX)
void	setInstance(int instance) [w] 0 , 3 , 0 , Environment Instance.
void	setLFReference(float LFReference) [r/w] 20.0 , 1000.0, 250.0 , reference low frequency (hz) (SUPPORTED:EAX/SFX)
void	setModulationDepth(float modulationDepth) [r/w] 0.0 , 1.0 , 0.0 , modulation depth (SUPPORTED:EAX)
void	setModulationTime(float modulationTime) [r/w] 0.04 , 4.0 , 0.25 , modulation time (SUPPORTED:EAX)
void	setReflections(int reflections) [r/w] -10000, 1000 , -2602 , early reflections level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)
void	setReflectionsDelay(float reflectionsDelay) [r/w] 0.0 , 0.3 , 0.007 , initial reflection delay time (SUPPORTED:EAX/I3DL2/SFX)
void	setReflectionsPan(java.nio.FloatBuffer reflectionsPan) [r/w] , , [0,0,0], early reflections panning vector (SUPPORTED:EAX)
void	setReverb(int reverb) [r/w] -10000, 2000 , 200 , late reverberation level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)
void	setReverbDelay(float reverbDelay) [r/w] 0.0 , 0.1 , 0.011 , late reverberation delay time relative to initial reflection (SUPPORTED:EAX/I3DL2/SFX)
void	setReverbPan(java.nio.FloatBuffer reverbPan) [r/w] , , [0,0,0], late reverberation panning vector (SUPPORTED:EAX)
void	setRoom(int room) [r/w] -10000, 0 , -1000 , room effect level (at mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)
void	setRoomHF(int roomHF) [r/w] -10000, 0 , -100 , relative room effect level at high frequencies (SUPPORTED:EAX/I3DL2/SFX)
void	setRoomLF(int roomLF) [r/w] -10000, 0 , 0 , relative room effect level at low frequencies (SUPPORTED:EAX/SFX)
void	setRoomRolloffFactor(float roomRolloffFactor) [r/w] 0.0 , 10.0 , 0.0 , like rolloffscale in System::set3DSettings but for reverb room size effect (SUPPORTED:EAX/I3DL2)

Methods inherited from class org.jouvieje.fmodex.utils.Pointer

asByteBuffer, asDouble, asFloat, asInt, asLong, asPointer, asString, asString, equals, isNull, shareMemory

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FMOD_REVERB_PROPERTIES

public FMOD_REVERB_PROPERTIES()

Create an object that holds a null FMOD_REVERB_PROPERTIES.
The call isNull() on the object created will returns true.

  FMOD_REVERB_PROPERTIES obj = new FMOD_REVERB_PROPERTIES();
  (obj == null) <=> false
  obj.isNull() <=> true
 

To creates a new FMOD_REVERB_PROPERTIES, use the static "constructor" :

  FMOD_REVERB_PROPERTIES obj = FMOD_REVERB_PROPERTIES.allocate();

See Also:

allocate()

Method Detail

create

public static FMOD_REVERB_PROPERTIES create(int preset)

Create an FMOD_REVERB_PROPERTIES using a preset FMOD_REVERB_PRESETS.

Parameters:

preset - a preset of the interface FMOD_REVERB_PRESETS.

See Also:

FMOD_REVERB_PRESETS

asFMOD_REVERB_PROPERTIES

public static FMOD_REVERB_PROPERTIES asFMOD_REVERB_PROPERTIES(Pointer pointer)

Create a view of the Pointer object as a FMOD_REVERB_PROPERTIES object.
This view is valid only if the memory holded by the Pointer holds a FMOD_REVERB_PROPERTIES object.

allocate

public static FMOD_REVERB_PROPERTIES allocate()

Allocate a new FMOD_REVERB_PROPERTIES.
The call isNull() on the object created will return false.

  FMOD_REVERB_PROPERTIES obj = FMOD_REVERB_PROPERTIES.allocate();
  (obj == null) <=> obj.isNull() <=> false
 

release

public void release()

getInstance

public int getInstance()

[w] 0 , 3 , 0 , Environment Instance. Simultaneous HW reverbs are possible on some platforms. (SUPPORTED:EAX4/SFX(3 instances) and Wii (2 instances))

setInstance

public void setInstance(int instance)

[w] 0 , 3 , 0 , Environment Instance. Simultaneous HW reverbs are possible on some platforms. (SUPPORTED:EAX4/SFX(3 instances) and Wii (2 instances))

getEnvironment

public int getEnvironment()

[r/w] -1 , 25 , -1 , sets all listener properties. -1 = OFF. (SUPPORTED:EAX/PS2)

setEnvironment

public void setEnvironment(int environment)

[r/w] -1 , 25 , -1 , sets all listener properties. -1 = OFF. (SUPPORTED:EAX/PS2)

getEnvSize

public float getEnvSize()

[r/w] 1.0 , 100.0 , 7.5 , environment size in meters (SUPPORTED:EAX)

setEnvSize

public void setEnvSize(float envSize)

[r/w] 1.0 , 100.0 , 7.5 , environment size in meters (SUPPORTED:EAX)

getEnvDiffusion

public float getEnvDiffusion()

[r/w] 0.0 , 1.0 , 1.0 , environment diffusion (SUPPORTED:EAX)

setEnvDiffusion

public void setEnvDiffusion(float envDiffusion)

[r/w] 0.0 , 1.0 , 1.0 , environment diffusion (SUPPORTED:EAX)

getRoom

public int getRoom()

[r/w] -10000, 0 , -1000 , room effect level (at mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)

setRoom

public void setRoom(int room)

[r/w] -10000, 0 , -1000 , room effect level (at mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)

getRoomHF

public int getRoomHF()

[r/w] -10000, 0 , -100 , relative room effect level at high frequencies (SUPPORTED:EAX/I3DL2/SFX)

setRoomHF

public void setRoomHF(int roomHF)

[r/w] -10000, 0 , -100 , relative room effect level at high frequencies (SUPPORTED:EAX/I3DL2/SFX)

getRoomLF

public int getRoomLF()

[r/w] -10000, 0 , 0 , relative room effect level at low frequencies (SUPPORTED:EAX/SFX)

setRoomLF

public void setRoomLF(int roomLF)

[r/w] -10000, 0 , 0 , relative room effect level at low frequencies (SUPPORTED:EAX/SFX)

getDecayTime

public float getDecayTime()

[r/w] 0.1 , 20.0 , 1.49 , reverberation decay time at mid frequencies (SUPPORTED:EAX/I3DL2/SFX)

setDecayTime

public void setDecayTime(float decayTime)

[r/w] 0.1 , 20.0 , 1.49 , reverberation decay time at mid frequencies (SUPPORTED:EAX/I3DL2/SFX)

getDecayHFRatio

public float getDecayHFRatio()

[r/w] 0.1 , 2.0 , 0.83 , high-frequency to mid-frequency decay time ratio (SUPPORTED:EAX/I3DL2/SFX)

setDecayHFRatio

public void setDecayHFRatio(float decayHFRatio)

[r/w] 0.1 , 2.0 , 0.83 , high-frequency to mid-frequency decay time ratio (SUPPORTED:EAX/I3DL2/SFX)

getDecayLFRatio

public float getDecayLFRatio()

[r/w] 0.1 , 2.0 , 1.0 , low-frequency to mid-frequency decay time ratio (SUPPORTED:EAX)

setDecayLFRatio

public void setDecayLFRatio(float decayLFRatio)

[r/w] 0.1 , 2.0 , 1.0 , low-frequency to mid-frequency decay time ratio (SUPPORTED:EAX)

getReflections

public int getReflections()

[r/w] -10000, 1000 , -2602 , early reflections level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)

setReflections

public void setReflections(int reflections)

[r/w] -10000, 1000 , -2602 , early reflections level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)

getReflectionsDelay

public float getReflectionsDelay()

[r/w] 0.0 , 0.3 , 0.007 , initial reflection delay time (SUPPORTED:EAX/I3DL2/SFX)

setReflectionsDelay

public void setReflectionsDelay(float reflectionsDelay)

[r/w] 0.0 , 0.3 , 0.007 , initial reflection delay time (SUPPORTED:EAX/I3DL2/SFX)

getReflectionsPan

public java.nio.FloatBuffer getReflectionsPan()

[r/w] , , [0,0,0], early reflections panning vector (SUPPORTED:EAX)

setReflectionsPan

public void setReflectionsPan(java.nio.FloatBuffer reflectionsPan)

[r/w] , , [0,0,0], early reflections panning vector (SUPPORTED:EAX)

getReverb

public int getReverb()

[r/w] -10000, 2000 , 200 , late reverberation level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)

setReverb

public void setReverb(int reverb)

[r/w] -10000, 2000 , 200 , late reverberation level relative to room effect (SUPPORTED:EAX/I3DL2/SFX)

getReverbDelay

public float getReverbDelay()

[r/w] 0.0 , 0.1 , 0.011 , late reverberation delay time relative to initial reflection (SUPPORTED:EAX/I3DL2/SFX)

setReverbDelay

public void setReverbDelay(float reverbDelay)

[r/w] 0.0 , 0.1 , 0.011 , late reverberation delay time relative to initial reflection (SUPPORTED:EAX/I3DL2/SFX)

getReverbPan

public java.nio.FloatBuffer getReverbPan()

[r/w] , , [0,0,0], late reverberation panning vector (SUPPORTED:EAX)

setReverbPan

public void setReverbPan(java.nio.FloatBuffer reverbPan)

[r/w] , , [0,0,0], late reverberation panning vector (SUPPORTED:EAX)

getEchoTime

public float getEchoTime()

[r/w] .075 , 0.25 , 0.25 , echo time (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO/FMOD_PRESET_PS2_DELAY only)

setEchoTime

public void setEchoTime(float echoTime)

[r/w] .075 , 0.25 , 0.25 , echo time (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO/FMOD_PRESET_PS2_DELAY only)

getEchoDepth

public float getEchoDepth()

[r/w] 0.0 , 1.0 , 0.0 , echo depth (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO only)

setEchoDepth

public void setEchoDepth(float echoDepth)

[r/w] 0.0 , 1.0 , 0.0 , echo depth (SUPPORTED:EAX/PS2(FMOD_PRESET_PS2_ECHO only)

getModulationTime

public float getModulationTime()

[r/w] 0.04 , 4.0 , 0.25 , modulation time (SUPPORTED:EAX)

setModulationTime

public void setModulationTime(float modulationTime)

[r/w] 0.04 , 4.0 , 0.25 , modulation time (SUPPORTED:EAX)

getModulationDepth

public float getModulationDepth()

[r/w] 0.0 , 1.0 , 0.0 , modulation depth (SUPPORTED:EAX)

setModulationDepth

public void setModulationDepth(float modulationDepth)

[r/w] 0.0 , 1.0 , 0.0 , modulation depth (SUPPORTED:EAX)

getAirAbsorptionHF

public float getAirAbsorptionHF()

[r/w] -100 , 0.0 , -5.0 , change in level per meter at high frequencies (SUPPORTED:EAX)

setAirAbsorptionHF

public void setAirAbsorptionHF(float airAbsorptionHF)

[r/w] -100 , 0.0 , -5.0 , change in level per meter at high frequencies (SUPPORTED:EAX)

getHFReference

public float getHFReference()

[r/w] 1000.0, 20000 , 5000.0 , reference high frequency (hz) (SUPPORTED:EAX/I3DL2/SFX)

setHFReference

public void setHFReference(float HFReference)

[r/w] 1000.0, 20000 , 5000.0 , reference high frequency (hz) (SUPPORTED:EAX/I3DL2/SFX)

getLFReference

public float getLFReference()

[r/w] 20.0 , 1000.0, 250.0 , reference low frequency (hz) (SUPPORTED:EAX/SFX)

setLFReference

public void setLFReference(float LFReference)

[r/w] 20.0 , 1000.0, 250.0 , reference low frequency (hz) (SUPPORTED:EAX/SFX)

getRoomRolloffFactor

public float getRoomRolloffFactor()

[r/w] 0.0 , 10.0 , 0.0 , like rolloffscale in System::set3DSettings but for reverb room size effect (SUPPORTED:EAX/I3DL2)

setRoomRolloffFactor

public void setRoomRolloffFactor(float roomRolloffFactor)

[r/w] 0.0 , 10.0 , 0.0 , like rolloffscale in System::set3DSettings but for reverb room size effect (SUPPORTED:EAX/I3DL2)

getDiffusion

public float getDiffusion()

[r/w] 0.0 , 100.0 , 100.0 , Value that controls the echo density in the late reverberation decay. (SUPPORTED:I3DL2/SFX)

setDiffusion

public void setDiffusion(float diffusion)

[r/w] 0.0 , 100.0 , 100.0 , Value that controls the echo density in the late reverberation decay. (SUPPORTED:I3DL2/SFX)

getDensity

public float getDensity()

[r/w] 0.0 , 100.0 , 100.0 , Value that controls the modal density in the late reverberation decay (SUPPORTED:I3DL2/SFX)

setDensity

public void setDensity(float density)

[r/w] 0.0 , 100.0 , 100.0 , Value that controls the modal density in the late reverberation decay (SUPPORTED:I3DL2/SFX)

getFlags

public int getFlags()

[r/w] FMOD_REVERB_FLAGS - modifies the behavior of above properties (SUPPORTED:EAX/PS2/WII)

setFlags

public void setFlags(int flags)

[r/w] FMOD_REVERB_FLAGS - modifies the behavior of above properties (SUPPORTED:EAX/PS2/WII)