|
| |
|
| java.lang.Object
 com.sun.j3d.audioengines.Sample
org.jdesktop.j3d.audioengines.joal.JOALSample
| JOALSample | | public class JOALSample extends Sample (Code) | | This is the JOAL Sample object which encapsulates all the functionality
and holds all the data associated with a Sample.
author:
David Grace (dave@dutchie.net) |
| Method Summary | |
| public void | clear()
Clears/re-initialize fields associated with sample data
for this sound,
and frees any device specific data associated with this sample. | | protected void | debugPrint(String message)
| | protected void | debugPrintln(String message)
| | public AL | getAl()
| | public int[] | getBuffer()
| | public int | getDirtyFlags()
| | public long | getDuration()
| | public float | getGain()
| | public int | getLoopCount()
| | public boolean | getMuteFlag()
| | public int | getNumberOfChannelsUsed()
| | public float | getObstructionGain()
| | public float | getOcclusionGain()
| | public float | getRateScaleFactor()
| | public MediaContainer | getSoundData()
| | public int | getSoundType()
| | public long | getStartTime()
| | public boolean | getVWrldXfrmFlag()
| | public boolean | load(AL al, MediaContainer soundData, int soundType)
Load the sound ready to by played. | | public boolean | load(AL al, int[] buffer, int soundType)
Load the sound ready to by played reusing the shared buffer. | | public void | render(int dirtyFlags, View view, AuralParameters attribs)
| | public void | setAngularAttenuation(int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff)
| | public void | setDirection(Vector3d direction)
| | public void | setDirtyFlags(int flags)
| | public void | setDistanceGain(double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor)
| | public void | setGain(float scaleFactor)
| | public void | setLoopCount(int count)
| | public void | setMuteFlag(boolean flag)
| | public void | setObstructionFilter(float cutoffFrequency)
| | public void | setObstructionGain(float scaleFactor)
| | public void | setOcclusionFilter(float cutoffFrequency)
| | public void | setOcclusionGain(float scaleFactor)
| | public void | setPosition(Point3d position)
| | public void | setRateScaleFactor(float scaleFactor)
| | public void | setSoundData(MediaContainer ref)
| | public void | setSoundType(int type)
| | public void | setVWrldXfrmFlag(boolean flag)
| | public int | startSample()
| | public int | stopSample()
|
| DURATION_UNKNOWN | | final public static int DURATION_UNKNOWN(Code) | | |
| LOW_PASS | | final public static int LOW_PASS(Code) | | |
| NO_FILTERING | | final public static int NO_FILTERING(Code) | | Distance Filter
Each sound source is attenuated by a filter based on it's distance
from the listener.
For now the only supported filterType will be LOW_PASS frequency
cutoff.
At some time full FIR filtering will be supported.
|
| NULL_SAMPLE | | final public static int NULL_SAMPLE(Code) | | Null Sound identifier denotes sound is not created or initialized
|
| angularDistance | | protected double[] angularDistance(Code) | | Directional Sound's gain can be attenuated based on the listener's
location off-angle from the source source direction.
This can be set by three parameters:
angular distance in radians
gain scale factor
filtering (currently the only filtering supported is lowpass)
|
| angularFilterCutoff | | protected float[] angularFilterCutoff(Code) | | |
| angularFilterType | | protected int angularFilterType(Code) | | |
| angularGain | | protected float[] angularGain(Code) | | |
| attenuationDistance | | protected double[] attenuationDistance(Code) | | |
| attenuationGain | | protected float[] attenuationGain(Code) | | |
| backAttenuationDistance | | protected double[] backAttenuationDistance(Code) | | Pairs of distances and gain scale factors that define piecewise linear
gain BACK attenuation between each pair.
These are used for defining elliptical attenuation regions.
|
| backAttenuationGain | | protected float[] backAttenuationGain(Code) | | |
| debugFlag | | final protected static boolean debugFlag(Code) | | |
| direction | | protected Vector3f direction(Code) | | The Cone Sound's direction vector. This is the cone axis.
|
| directionArray | | protected float[] directionArray(Code) | | |
| dirtyFlags | | protected int dirtyFlags(Code) | | dirty flags denoting what has changed since last rendering
|
| duration | | protected long duration(Code) | | |
| gain | | protected float gain(Code) | | Overall Scale Factor applied to sound gain.
|
| internalErrors | | final protected static boolean internalErrors(Code) | | |
| loopCount | | protected int loopCount(Code) | | Number of times sound is looped/repeated during play
|
| mute | | protected boolean mute(Code) | | |
| numberOfChannels | | protected int numberOfChannels(Code) | | |
| obstructionFilterCutoff | | protected float obstructionFilterCutoff(Code) | | |
| obstructionFilterType | | protected int obstructionFilterType(Code) | | |
| obstructionGain | | protected float obstructionGain(Code) | | |
| occlusionFilterCutoff | | protected float occlusionFilterCutoff(Code) | | |
| occlusionFilterType | | protected int occlusionFilterType(Code) | | |
| occlusionGain | | protected float occlusionGain(Code) | | |
| position | | protected Point3f position(Code) | | |
| positionArray | | protected float[] positionArray(Code) | | |
| rateScaleFactor | | protected float rateScaleFactor(Code) | | Overall Scale Factor applied to sound.
since:
Java 3D 1.3 |
| soundType | | protected int soundType(Code) | | sound data associated with sound source
|
| vwXfrmFlag | | protected boolean vwXfrmFlag(Code) | | |
| JOALSample | | public JOALSample()(Code) | | Creates a new instance of JOALSample
|
| clear | | public void clear()(Code) | | Clears/re-initialize fields associated with sample data
for this sound,
and frees any device specific data associated with this sample.
|
| debugPrintln | | protected void debugPrintln(String message)(Code) | | |
| getBuffer | | public int[] getBuffer()(Code) | | |
| getDirtyFlags | | public int getDirtyFlags()(Code) | | |
| getDuration | | public long getDuration()(Code) | | |
| getGain | | public float getGain()(Code) | | |
| getLoopCount | | public int getLoopCount()(Code) | | |
| getMuteFlag | | public boolean getMuteFlag()(Code) | | |
| getNumberOfChannelsUsed | | public int getNumberOfChannelsUsed()(Code) | | |
| getObstructionGain | | public float getObstructionGain()(Code) | | |
| getOcclusionGain | | public float getOcclusionGain()(Code) | | |
| getRateScaleFactor | | public float getRateScaleFactor()(Code) | | |
| getSoundType | | public int getSoundType()(Code) | | |
| getStartTime | | public long getStartTime()(Code) | | |
| getVWrldXfrmFlag | | public boolean getVWrldXfrmFlag()(Code) | | |
| load | | public boolean load(AL al, MediaContainer soundData, int soundType)(Code) | | Load the sound ready to by played.
error true if error occurred |
| load | | public boolean load(AL al, int[] buffer, int soundType)(Code) | | Load the sound ready to by played reusing the shared buffer.
error true if error occurred |
| setAngularAttenuation | | public void setAngularAttenuation(int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff)(Code) | | |
| setDirection | | public void setDirection(Vector3d direction)(Code) | | |
| setDirtyFlags | | public void setDirtyFlags(int flags)(Code) | | |
| setDistanceGain | | public void setDistanceGain(double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor)(Code) | | |
| setGain | | public void setGain(float scaleFactor)(Code) | | |
| setLoopCount | | public void setLoopCount(int count)(Code) | | |
| setMuteFlag | | public void setMuteFlag(boolean flag)(Code) | | |
| setObstructionFilter | | public void setObstructionFilter(float cutoffFrequency)(Code) | | |
| setObstructionGain | | public void setObstructionGain(float scaleFactor)(Code) | | |
| setOcclusionFilter | | public void setOcclusionFilter(float cutoffFrequency)(Code) | | |
| setOcclusionGain | | public void setOcclusionGain(float scaleFactor)(Code) | | |
| setPosition | | public void setPosition(Point3d position)(Code) | | |
| setRateScaleFactor | | public void setRateScaleFactor(float scaleFactor)(Code) | | |
| setSoundType | | public void setSoundType(int type)(Code) | | |
| setVWrldXfrmFlag | | public void setVWrldXfrmFlag(boolean flag)(Code) | | |
| startSample | | public int startSample()(Code) | | |
| stopSample | | public int stopSample()(Code) | | |
|
|
|