org.jouvieje.fmodex.structures
Class FMOD_REVERB_CHANNELPROPERTIES

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

public class FMOD_REVERB_CHANNELPROPERTIES

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_REVERB_CHANNELPROPERTIES	allocate() Allocate a new FMOD_REVERB_CHANNELPROPERTIES.
static FMOD_REVERB_CHANNELPROPERTIES	asFMOD_REVERB_CHANNELPROPERTIES(Pointer pointer) Create a view of the Pointer object as a FMOD_REVERB_CHANNELPROPERTIES object.
float	getAirAbsorptionFactor() [r/w] 0.0, 10.0, 1.0, multiplies AirAbsorptionHF member of FMOD_REVERB_PROPERTIES (SUPPORTED:EAX only)
DSP	getConnectionPoint() [r/w] See remarks.
int	getDirect() [r/w] -10000, 1000, 0, direct path level (at low and mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)
int	getDirectHF() [r/w] -10000, 0, 0, relative direct path level at high frequencies (SUPPORTED:EAX/I3DL2)
float	getDopplerFactor() [r/w] 0.0, 10.0, 0.0, like DS3D flDopplerFactor but per source (SUPPORTED:EAX only)
int	getExclusion() [r/w] -10000, 0, 0, main exlusion control (attenuation at high frequencies) (SUPPORTED:EAX only)
float	getExclusionLFRatio() [r/w] 0.0, 1.0, 1.0, exclusion low-frequency level re. main control (SUPPORTED:EAX only)
int	getFlags() [r/w] FMOD_REVERB_CHANNELFLAGS - modifies the behavior of properties (SUPPORTED:EAX/SFX)
int	getObstruction() [r/w] -10000, 0, 0, main obstruction control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)
float	getObstructionLFRatio() [r/w] 0.0, 1.0, 0.0, obstruction low-frequency level re. main control (SUPPORTED:EAX/I3DL2)
int	getOcclusion() [r/w] -10000, 0, 0, main occlusion control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)
float	getOcclusionDirectRatio() [r/w] 0.0, 10.0, 1.0, relative occlusion control for direct path (SUPPORTED:EAX only)
float	getOcclusionLFRatio() [r/w] 0.0, 1.0, 0.25, occlusion low-frequency level re. main control (SUPPORTED:EAX/I3DL2)
float	getOcclusionRoomRatio() [r/w] 0.0, 10.0, 1.5, relative occlusion control for room effect (SUPPORTED:EAX only)
int	getOutsideVolumeHF() [r/w] -10000, 0, 0, outside sound cone level at high frequencies (SUPPORTED:EAX only)
float	getRolloffFactor() [r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but per source (SUPPORTED:EAX only)
int	getRoom() [r/w] -10000, 1000, 0, room effect level (at low and mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)
int	getRoomHF() [r/w] -10000, 0, 0, relative room effect level at high frequencies (SUPPORTED:EAX/I3DL2)
float	getRoomRolloffFactor() [r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but for room effect (SUPPORTED:EAX/I3DL2)
void	release()
void	setAirAbsorptionFactor(float airAbsorptionFactor) [r/w] 0.0, 10.0, 1.0, multiplies AirAbsorptionHF member of FMOD_REVERB_PROPERTIES (SUPPORTED:EAX only)
void	setConnectionPoint(DSP connectionPoint) [r/w] See remarks.
void	setDirect(int direct) [r/w] -10000, 1000, 0, direct path level (at low and mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)
void	setDirectHF(int directHF) [r/w] -10000, 0, 0, relative direct path level at high frequencies (SUPPORTED:EAX/I3DL2)
void	setDopplerFactor(float dopplerFactor) [r/w] 0.0, 10.0, 0.0, like DS3D flDopplerFactor but per source (SUPPORTED:EAX only)
void	setExclusion(int exclusion) [r/w] -10000, 0, 0, main exlusion control (attenuation at high frequencies) (SUPPORTED:EAX only)
void	setExclusionLFRatio(float exclusionLFRatio) [r/w] 0.0, 1.0, 1.0, exclusion low-frequency level re. main control (SUPPORTED:EAX only)
void	setFlags(int flags) [r/w] FMOD_REVERB_CHANNELFLAGS - modifies the behavior of properties (SUPPORTED:EAX/SFX)
void	setObstruction(int obstruction) [r/w] -10000, 0, 0, main obstruction control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)
void	setObstructionLFRatio(float obstructionLFRatio) [r/w] 0.0, 1.0, 0.0, obstruction low-frequency level re. main control (SUPPORTED:EAX/I3DL2)
void	setOcclusion(int occlusion) [r/w] -10000, 0, 0, main occlusion control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)
void	setOcclusionDirectRatio(float occlusionDirectRatio) [r/w] 0.0, 10.0, 1.0, relative occlusion control for direct path (SUPPORTED:EAX only)
void	setOcclusionLFRatio(float occlusionLFRatio) [r/w] 0.0, 1.0, 0.25, occlusion low-frequency level re. main control (SUPPORTED:EAX/I3DL2)
void	setOcclusionRoomRatio(float occlusionRoomRatio) [r/w] 0.0, 10.0, 1.5, relative occlusion control for room effect (SUPPORTED:EAX only)
void	setOutsideVolumeHF(int outsideVolumeHF) [r/w] -10000, 0, 0, outside sound cone level at high frequencies (SUPPORTED:EAX only)
void	setRolloffFactor(float rolloffFactor) [r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but per source (SUPPORTED:EAX only)
void	setRoom(int room) [r/w] -10000, 1000, 0, room effect level (at low and mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)
void	setRoomHF(int roomHF) [r/w] -10000, 0, 0, relative room effect level at high frequencies (SUPPORTED:EAX/I3DL2)
void	setRoomRolloffFactor(float roomRolloffFactor) [r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but for room 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_CHANNELPROPERTIES

public FMOD_REVERB_CHANNELPROPERTIES()

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

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

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

  FMOD_REVERB_CHANNELPROPERTIES obj = FMOD_REVERB_CHANNELPROPERTIES.allocate();

See Also:

allocate()

Method Detail

asFMOD_REVERB_CHANNELPROPERTIES

public static FMOD_REVERB_CHANNELPROPERTIES asFMOD_REVERB_CHANNELPROPERTIES(Pointer pointer)

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

allocate

public static FMOD_REVERB_CHANNELPROPERTIES allocate()

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

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

release

public void release()

getDirect

public int getDirect()

[r/w] -10000, 1000, 0, direct path level (at low and mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)

setDirect

public void setDirect(int direct)

[r/w] -10000, 1000, 0, direct path level (at low and mid frequencies) (SUPPORTED:EAX/I3DL2/SFX)

getDirectHF

public int getDirectHF()

[r/w] -10000, 0, 0, relative direct path level at high frequencies (SUPPORTED:EAX/I3DL2)

setDirectHF

public void setDirectHF(int directHF)

[r/w] -10000, 0, 0, relative direct path level at high frequencies (SUPPORTED:EAX/I3DL2)

getRoom

public int getRoom()

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

setRoom

public void setRoom(int room)

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

getRoomHF

public int getRoomHF()

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

setRoomHF

public void setRoomHF(int roomHF)

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

getObstruction

public int getObstruction()

[r/w] -10000, 0, 0, main obstruction control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)

setObstruction

public void setObstruction(int obstruction)

[r/w] -10000, 0, 0, main obstruction control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)

getObstructionLFRatio

public float getObstructionLFRatio()

[r/w] 0.0, 1.0, 0.0, obstruction low-frequency level re. main control (SUPPORTED:EAX/I3DL2)

setObstructionLFRatio

public void setObstructionLFRatio(float obstructionLFRatio)

[r/w] 0.0, 1.0, 0.0, obstruction low-frequency level re. main control (SUPPORTED:EAX/I3DL2)

getOcclusion

public int getOcclusion()

[r/w] -10000, 0, 0, main occlusion control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)

setOcclusion

public void setOcclusion(int occlusion)

[r/w] -10000, 0, 0, main occlusion control (attenuation at high frequencies) (SUPPORTED:EAX/I3DL2)

getOcclusionLFRatio

public float getOcclusionLFRatio()

[r/w] 0.0, 1.0, 0.25, occlusion low-frequency level re. main control (SUPPORTED:EAX/I3DL2)

setOcclusionLFRatio

public void setOcclusionLFRatio(float occlusionLFRatio)

[r/w] 0.0, 1.0, 0.25, occlusion low-frequency level re. main control (SUPPORTED:EAX/I3DL2)

getOcclusionRoomRatio

public float getOcclusionRoomRatio()

[r/w] 0.0, 10.0, 1.5, relative occlusion control for room effect (SUPPORTED:EAX only)

setOcclusionRoomRatio

public void setOcclusionRoomRatio(float occlusionRoomRatio)

[r/w] 0.0, 10.0, 1.5, relative occlusion control for room effect (SUPPORTED:EAX only)

getOcclusionDirectRatio

public float getOcclusionDirectRatio()

[r/w] 0.0, 10.0, 1.0, relative occlusion control for direct path (SUPPORTED:EAX only)

setOcclusionDirectRatio

public void setOcclusionDirectRatio(float occlusionDirectRatio)

[r/w] 0.0, 10.0, 1.0, relative occlusion control for direct path (SUPPORTED:EAX only)

getExclusion

public int getExclusion()

[r/w] -10000, 0, 0, main exlusion control (attenuation at high frequencies) (SUPPORTED:EAX only)

setExclusion

public void setExclusion(int exclusion)

[r/w] -10000, 0, 0, main exlusion control (attenuation at high frequencies) (SUPPORTED:EAX only)

getExclusionLFRatio

public float getExclusionLFRatio()

[r/w] 0.0, 1.0, 1.0, exclusion low-frequency level re. main control (SUPPORTED:EAX only)

setExclusionLFRatio

public void setExclusionLFRatio(float exclusionLFRatio)

[r/w] 0.0, 1.0, 1.0, exclusion low-frequency level re. main control (SUPPORTED:EAX only)

getOutsideVolumeHF

public int getOutsideVolumeHF()

[r/w] -10000, 0, 0, outside sound cone level at high frequencies (SUPPORTED:EAX only)

setOutsideVolumeHF

public void setOutsideVolumeHF(int outsideVolumeHF)

[r/w] -10000, 0, 0, outside sound cone level at high frequencies (SUPPORTED:EAX only)

getDopplerFactor

public float getDopplerFactor()

[r/w] 0.0, 10.0, 0.0, like DS3D flDopplerFactor but per source (SUPPORTED:EAX only)

setDopplerFactor

public void setDopplerFactor(float dopplerFactor)

[r/w] 0.0, 10.0, 0.0, like DS3D flDopplerFactor but per source (SUPPORTED:EAX only)

getRolloffFactor

public float getRolloffFactor()

[r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but per source (SUPPORTED:EAX only)

setRolloffFactor

public void setRolloffFactor(float rolloffFactor)

[r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but per source (SUPPORTED:EAX only)

getRoomRolloffFactor

public float getRoomRolloffFactor()

[r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but for room effect (SUPPORTED:EAX/I3DL2)

setRoomRolloffFactor

public void setRoomRolloffFactor(float roomRolloffFactor)

[r/w] 0.0, 10.0, 0.0, like DS3D flRolloffFactor but for room effect (SUPPORTED:EAX/I3DL2)

getAirAbsorptionFactor

public float getAirAbsorptionFactor()

[r/w] 0.0, 10.0, 1.0, multiplies AirAbsorptionHF member of FMOD_REVERB_PROPERTIES (SUPPORTED:EAX only)

setAirAbsorptionFactor

public void setAirAbsorptionFactor(float airAbsorptionFactor)

[r/w] 0.0, 10.0, 1.0, multiplies AirAbsorptionHF member of FMOD_REVERB_PROPERTIES (SUPPORTED:EAX only)

getFlags

public int getFlags()

[r/w] FMOD_REVERB_CHANNELFLAGS - modifies the behavior of properties (SUPPORTED:EAX/SFX)

setFlags

public void setFlags(int flags)

[r/w] FMOD_REVERB_CHANNELFLAGS - modifies the behavior of properties (SUPPORTED:EAX/SFX)

getConnectionPoint

public DSP getConnectionPoint()

[r/w] See remarks. DSP network location to connect reverb for this channel. (SUPPORTED:SFX only).

setConnectionPoint

public void setConnectionPoint(DSP connectionPoint)

[r/w] See remarks. DSP network location to connect reverb for this channel. (SUPPORTED:SFX only).