Package com.jme3.audio

Class BandPassFilter

java.lang.Object

com.jme3.util.NativeObject

com.jme3.audio.Filter

com.jme3.audio.BandPassFilter

All Implemented Interfaces:

Savable, JmeCloneable, Cloneable

public class BandPassFilter
extends Filter

Represents an OpenAL EFX Band-Pass Filter.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	highFreqVolume
protected float	lowFreqVolume
protected float	volume

Fields inherited from class com.jme3.util.NativeObject

handleRef, id, INVALID_ID, objectManager, OBJTYPE_AUDIOBUFFER, OBJTYPE_AUDIOSTREAM, OBJTYPE_BO, OBJTYPE_FILTER, OBJTYPE_FRAMEBUFFER, OBJTYPE_SHADER, OBJTYPE_SHADERSOURCE, OBJTYPE_TEXTURE, OBJTYPE_VERTEXBUFFER, updateNeeded

Constructor Summary

Constructors

Modifier	Constructor	Description
	BandPassFilter()	Constructs a band-pass filter with default settings.
	BandPassFilter(float volume, float highFreqVolume, float lowFreqVolume)
protected	BandPassFilter(int id)

Method Summary

Modifier and Type	Method	Description
NativeObject	createDestructableClone()	Creates a shallow clone of this GL Object.
float	getHighFreqVolume()
float	getLowFreqVolume()
long	getUniqueId()	Retrieves a unique identifier for this filter.
float	getVolume()
void	read(JmeImporter im)
void	setHighFreqVolume(float highFreqVolume)	Sets the gain at high frequencies for the Band-Pass filter.
void	setLowFreqVolume(float lowFreqVolume)	Sets the gain at low frequencies for the Band-Pass filter.
void	setVolume(float volume)	Sets the overall gain of the Band-Pass filter.
void	write(JmeExporter ex)

Methods inherited from class com.jme3.audio.Filter

cloneFields, deleteObject, jmeClone, resetObject

Methods inherited from class com.jme3.util.NativeObject

clearUpdateNeeded, clone, deleteNativeBuffers, dispose, getId, getWeakRef, isUpdateNeeded, setId, setUpdateNeeded, toString

Methods inherited from class java.lang.Object

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

Field Details

volume

protected float volume

highFreqVolume

protected float highFreqVolume

lowFreqVolume

protected float lowFreqVolume

Constructor Details

BandPassFilter

public BandPassFilter()

Constructs a band-pass filter with default settings. Required for jME deserialization

BandPassFilter

protected BandPassFilter(int id)

BandPassFilter

public BandPassFilter(float volume,
 float highFreqVolume,
 float lowFreqVolume)

Method Details

getVolume

public float getVolume()

setVolume

public void setVolume(float volume)

Sets the overall gain of the Band-Pass filter.

Parameters:

volume - The gain value (0.0 to 1.0).

getHighFreqVolume

public float getHighFreqVolume()

setHighFreqVolume

public void setHighFreqVolume(float highFreqVolume)

Sets the gain at high frequencies for the Band-Pass filter.

Parameters:

highFreqVolume - The high-frequency gain value (0.0 to 1.0).

getLowFreqVolume

public float getLowFreqVolume()

setLowFreqVolume

public void setLowFreqVolume(float lowFreqVolume)

Sets the gain at low frequencies for the Band-Pass filter.

Parameters:

lowFreqVolume - The low-frequency gain value (0.0 to 1.0).

createDestructableClone

public NativeObject createDestructableClone()

Description copied from class: NativeObject

Creates a shallow clone of this GL Object. The deleteObject method should be functional for this object.

Specified by:

createDestructableClone in class Filter

Returns:

a new instance

getUniqueId

public long getUniqueId()

Retrieves a unique identifier for this filter. Used internally for native object management.

Specified by:

getUniqueId in class NativeObject

Returns:

a unique long identifier.

write

public void write(JmeExporter ex)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class Filter

Throws:

IOException

read

public void read(JmeImporter im)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class Filter

Throws:

IOException