JOALSample

java.lang.Object
- org.jogamp.java3d.audioengines.Sample
- - org.jdesktop.j3d.examples.sound.audio.JOALSample

```
public class JOALSample
extends Sample
```
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)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DURATION_UNKNOWN`
`static int`	`LOW_PASS`
`static int`	`NO_FILTERING` Distance Filter Each sound source is attenuated by a filter based on it's distance from the listener.
`static int`	`NULL_SAMPLE` Null Sound identifier denotes sound is not created or initialized

Constructor Summary

Constructors
Constructor and Description

JOALSample()
Creates a new instance of JOALSample

Constructors
Constructor and Description
`JOALSample()` Creates a new instance of JOALSample

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears/re-initialize fields associated with sample data for this sound, and frees any device specific data associated with this sample.
`com.jogamp.openal.AL`	`getAl()`
`int[]`	`getBuffer()`
`int`	`getDirtyFlags()`
`long`	`getDuration()`
`float`	`getGain()`
`int`	`getLoopCount()`
`boolean`	`getMuteFlag()`
`int`	`getNumberOfChannelsUsed()`
`float`	`getObstructionGain()`
`float`	`getOcclusionGain()`
`float`	`getRateScaleFactor()`
`MediaContainer`	`getSoundData()`
`int`	`getSoundType()`
`long`	`getStartTime()`
`boolean`	`getVWrldXfrmFlag()`
`boolean`	`load(com.jogamp.openal.AL al, int[] buffer, int soundType)` Load the sound ready to by played reusing the shared buffer.
`boolean`	`load(com.jogamp.openal.AL al, MediaContainer soundData, int soundType)` Load the sound ready to by played.
`void`	`render(int dirtyFlags, View view, AuralParameters attribs)`
`void`	`setAngularAttenuation(int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff)`
`void`	`setDirection(Vector3d direction)`
`void`	`setDirtyFlags(int flags)`
`void`	`setDistanceGain(double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor)`
`void`	`setGain(float scaleFactor)`
`void`	`setLoopCount(int count)`
`void`	`setMuteFlag(boolean flag)`
`void`	`setObstructionFilter(float cutoffFrequency)`
`void`	`setObstructionGain(float scaleFactor)`
`void`	`setOcclusionFilter(float cutoffFrequency)`
`void`	`setOcclusionGain(float scaleFactor)`
`void`	`setPosition(Point3d position)`
`void`	`setRateScaleFactor(float scaleFactor)`
`void`	`setSoundData(MediaContainer ref)`
`void`	`setSoundType(int type)`
`void`	`setVWrldXfrmFlag(boolean flag)`
`int`	`startSample()`
`int`	`stopSample()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NULL_SAMPLE
```
public static final int NULL_SAMPLE
```
    Null Sound identifier denotes sound is not created or initialized
    
    See Also:
    
    Constant Field Values
  - DURATION_UNKNOWN
```
public static final int DURATION_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - NO_FILTERING
```
public static final int NO_FILTERING
```
    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.
    
    See Also:
    
    Constant Field Values
  - LOW_PASS
```
public static final int LOW_PASS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JOALSample
```
public JOALSample()
```
    Creates a new instance of JOALSample
- Method Detail
  - getDuration
```
public long getDuration()
```
    Overrides:
    
    getDuration in class Sample
  - getStartTime
```
public long getStartTime()
```
    Overrides:
    
    getStartTime in class Sample
  - getNumberOfChannelsUsed
```
public int getNumberOfChannelsUsed()
```
    Overrides:
    
    getNumberOfChannelsUsed in class Sample
  - setDirtyFlags
```
public void setDirtyFlags(int flags)
```
    Overrides:
    
    setDirtyFlags in class Sample
  - getDirtyFlags
```
public int getDirtyFlags()
```
    Overrides:
    
    getDirtyFlags in class Sample
  - setSoundType
```
public void setSoundType(int type)
```
    Overrides:
    
    setSoundType in class Sample
  - getSoundType
```
public int getSoundType()
```
    Overrides:
    
    getSoundType in class Sample
  - setSoundData
```
public void setSoundData(MediaContainer ref)
```
    Overrides:
    
    setSoundData in class Sample
  - getSoundData
```
public MediaContainer getSoundData()
```
    Overrides:
    
    getSoundData in class Sample
  - setMuteFlag
```
public void setMuteFlag(boolean flag)
```
    Overrides:
    
    setMuteFlag in class Sample
  - getMuteFlag
```
public boolean getMuteFlag()
```
    Overrides:
    
    getMuteFlag in class Sample
  - setVWrldXfrmFlag
```
public void setVWrldXfrmFlag(boolean flag)
```
    Overrides:
    
    setVWrldXfrmFlag in class Sample
  - getVWrldXfrmFlag
```
public boolean getVWrldXfrmFlag()
```
    Overrides:
    
    getVWrldXfrmFlag in class Sample
  - setGain
```
public void setGain(float scaleFactor)
```
    Overrides:
    
    setGain in class Sample
  - getGain
```
public float getGain()
```
    Overrides:
    
    getGain in class Sample
  - setLoopCount
```
public void setLoopCount(int count)
```
    Overrides:
    
    setLoopCount in class Sample
  - getLoopCount
```
public int getLoopCount()
```
    Overrides:
    
    getLoopCount in class Sample
  - setPosition
```
public void setPosition(Point3d position)
```
    Overrides:
    
    setPosition in class Sample
  - setDistanceGain
```
public void setDistanceGain(double[] frontDistance,
                            float[] frontAttenuationScaleFactor,
                            double[] backDistance,
                            float[] backAttenuationScaleFactor)
```
    Overrides:
    
    setDistanceGain in class Sample
  - setDirection
```
public void setDirection(Vector3d direction)
```
    Overrides:
    
    setDirection in class Sample
  - setAngularAttenuation
```
public void setAngularAttenuation(int filterType,
                                  double[] angle,
                                  float[] attenuationScaleFactor,
                                  float[] filterCutoff)
```
    Overrides:
    
    setAngularAttenuation in class Sample
  - setRateScaleFactor
```
public void setRateScaleFactor(float scaleFactor)
```
    Overrides:
    
    setRateScaleFactor in class Sample
  - getRateScaleFactor
```
public float getRateScaleFactor()
```
    Overrides:
    
    getRateScaleFactor in class Sample
  - setObstructionGain
```
public void setObstructionGain(float scaleFactor)
```
    Overrides:
    
    setObstructionGain in class Sample
  - getObstructionGain
```
public float getObstructionGain()
```
    Overrides:
    
    getObstructionGain in class Sample
  - setObstructionFilter
```
public void setObstructionFilter(float cutoffFrequency)
```
    Overrides:
    
    setObstructionFilter in class Sample
  - setOcclusionGain
```
public void setOcclusionGain(float scaleFactor)
```
    Overrides:
    
    setOcclusionGain in class Sample
  - getOcclusionGain
```
public float getOcclusionGain()
```
    Overrides:
    
    getOcclusionGain in class Sample
  - setOcclusionFilter
```
public void setOcclusionFilter(float cutoffFrequency)
```
    Overrides:
    
    setOcclusionFilter in class Sample
  - clear
```
public void clear()
```
    Clears/re-initialize fields associated with sample data for this sound, and frees any device specific data associated with this sample.
    
    Overrides:
    
    clear in class Sample
  - render
```
public void render(int dirtyFlags,
                   View view,
                   AuralParameters attribs)
```
    Overrides:
    
    render in class Sample
  - load
```
public boolean load(com.jogamp.openal.AL al,
                    MediaContainer soundData,
                    int soundType)
```
    Load the sound ready to by played.
    
    Returns:
    
    error true if error occurred
  - load
```
public boolean load(com.jogamp.openal.AL al,
                    int[] buffer,
                    int soundType)
```
    Load the sound ready to by played reusing the shared buffer.
    
    Returns:
    
    error true if error occurred
  - startSample
```
public int startSample()
```
  - stopSample
```
public int stopSample()
```
  - getAl
```
public com.jogamp.openal.AL getAl()
```
  - getBuffer
```
public int[] getBuffer()
```

Class JOALSample

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_SAMPLE

DURATION_UNKNOWN

NO_FILTERING

LOW_PASS

Constructor Detail

JOALSample

Method Detail

getDuration

getStartTime

getNumberOfChannelsUsed

setDirtyFlags

getDirtyFlags

setSoundType

getSoundType

setSoundData

getSoundData

setMuteFlag

getMuteFlag

setVWrldXfrmFlag

getVWrldXfrmFlag

setGain

getGain

setLoopCount

getLoopCount

setPosition

setDistanceGain

setDirection

setAngularAttenuation

setRateScaleFactor

getRateScaleFactor

setObstructionGain

getObstructionGain

setObstructionFilter

setOcclusionGain

getOcclusionGain

setOcclusionFilter

clear

render

load

load

startSample

stopSample

getAl

getBuffer