|
| |
|
| java.lang.Object
 javax.media.j3d.IndexedObject
javax.media.j3d.SceneGraphObjectRetained
javax.media.j3d.NodeComponentRetained
javax.media.j3d.AuralAttributesRetained
| AuralAttributesRetained | | class AuralAttributesRetained extends NodeComponentRetained (Code) | | The AuralAttributesRetained object defines all rendering state that can
be set as a component object of a retained Soundscape node.
|
| Field Summary | |
| final static int | LOW_PASS
| | final static int | NO_FILTERING
Distance Filter
Each sound source is attenuated by a filter based on it's distance
from the listener. | | final static float | SPEED_OF_SOUND
| | boolean | aaDirty
| | float | attributeGain
| | final static boolean | debugFlag
| | float | decayFilter
| | float | decayTime
| | float | density
| | float | diffusion
| | float[] | distance
| | int | filterType
| | float[] | frequencyCutoff
| | float | frequencyScaleFactor
Frequency Scale Factor
used to increase or reduce the change of frequency associated
with normal rate of playback. | | final static boolean | internalErrors
| | AuralAttributesRetained | mirrorAa
The mirror copy of this AuralAttributes. | | float | reflectionCoefficient
Coefficients for reverberation
The (early) Reflection and Reverberation coefficient scale factors
are used to approximate the reflective/absorptive characteristics
of the surfaces in this bounded Auralizaton environment. | | float | reflectionDelay
Time Delays in milliseconds
Set with either explicitly with time, or impliciticly by supplying
bounds volume and having the delay time calculated. | | Bounds | reverbBounds
| | float | reverbCoefficient
| | float | reverbDelay
| | int | reverbOrder
Reverberation order
This limits the number of Reverberation iterations executed while
sound is being reverberated. | | float | rolloff
Atmospheric Rolloff - speed of sound - coeff
Normal gain attenuation based on distance of sound from
listener is scaled by a rolloff factor, which can increase
or decrease the usual inverse-distance-square value. | | float | velocityScaleFactor
Velocity Scale Factor
Float value applied to the Change of distance between Sound Source
and Listener over some delta time. |
| LOW_PASS | | final static int LOW_PASS(Code) | | |
| NO_FILTERING | | final 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.
|
| SPEED_OF_SOUND | | final static float SPEED_OF_SOUND(Code) | | |
| aaDirty | | boolean aaDirty(Code) | | This boolean is set when something changes in the attributes
|
| attributeGain | | float attributeGain(Code) | | Gain Scale Factor applied to source with this attribute
|
| debugFlag | | final static boolean debugFlag(Code) | | Debug print mechanism for Sound nodes
|
| decayFilter | | float decayFilter(Code) | | |
| decayTime | | float decayTime(Code) | | Decay parameters
Length and timbre of reverb decay tail
|
| diffusion | | float diffusion(Code) | | Reverb Diffusion and Density ratios (0=min, 1=max)
|
| distance | | float[] distance(Code) | | |
| filterType | | int filterType(Code) | | |
| frequencyCutoff | | float[] frequencyCutoff(Code) | | |
| frequencyScaleFactor | | float frequencyScaleFactor(Code) | | Frequency Scale Factor
used to increase or reduce the change of frequency associated
with normal rate of playback.
Value of zero causes sounds to be paused.
|
| internalErrors | | final static boolean internalErrors(Code) | | |
| reflectionCoefficient | | float reflectionCoefficient(Code) | | Coefficients for reverberation
The (early) Reflection and Reverberation coefficient scale factors
are used to approximate the reflective/absorptive characteristics
of the surfaces in this bounded Auralizaton environment.
Theses scale factors is applied to sound's amplitude regardless
of sound's position.
Value of 1.0 represents complete (unattenuated) sound reflection.
Value of 0.0 represents full absorption; reverberation is disabled.
|
| reflectionDelay | | float reflectionDelay(Code) | | Time Delays in milliseconds
Set with either explicitly with time, or impliciticly by supplying
bounds volume and having the delay time calculated.
Bounds of reverberation space does not have to be the same as
Attribute bounds.
|
| reverbCoefficient | | float reverbCoefficient(Code) | | |
| reverbDelay | | float reverbDelay(Code) | | |
| reverbOrder | | int reverbOrder(Code) | | Reverberation order
This limits the number of Reverberation iterations executed while
sound is being reverberated. As long as reflection coefficient is
small enough, the reverberated sound decreases (as it would naturally)
each successive iteration.
Value of > zero defines the greatest reflection order to be used by
the reverberator.
All positive values are used as the number of loop iteration.
Value of <= zero signifies that reverberation is to loop until reverb
gain reaches zero (-60dB or 1/1000 of sound amplitude).
|
| rolloff | | float rolloff(Code) | | Atmospheric Rolloff - speed of sound - coeff
Normal gain attenuation based on distance of sound from
listener is scaled by a rolloff factor, which can increase
or decrease the usual inverse-distance-square value.
|
| velocityScaleFactor | | float velocityScaleFactor(Code) | | Velocity Scale Factor
Float value applied to the Change of distance between Sound Source
and Listener over some delta time. Non-zero if listener moving
even if sound is not. Value of zero implies no Doppler applied.
|
| getAttributeGain | | float getAttributeGain()(Code) | | Retrieve Attribute Gain (amplitude)
gain amplitude scale factor |
| getDecayFilter | | float getDecayFilter()(Code) | | Retrieve Revereration Decay Filter
reverb delay Filter |
| getDecayTime | | float getDecayTime()(Code) | | Retrieve Revereration Decay Time
reverb delay time |
| getDensity | | float getDensity()(Code) | | Retrieve Revereration Density
reverb density |
| getDiffusion | | float getDiffusion()(Code) | | Retrieve Revereration Decay Diffusion
reverb diffusion |
| getDistanceFilter | | void getDistanceFilter(Point2f[] attenuation)(Code) | | Retrieve Distance Filter (distances and frequency cutoff)
attenaution pairs of distance and frequency cutoff filter |
| getDistanceFilter | | void getDistanceFilter(float[] distance, float[] filter)(Code) | | Retrieve Distance Filter as arrays distances and frequency cutoff array
Parameters:
distance - array of float values
Parameters:
frequencyCutoff - array of float cutoff filter values in Hertz |
| getDistanceFilterLength | | int getDistanceFilterLength()(Code) | | Retrieve Distance Filter array length
attenuation array length |
| getFrequencyScaleFactor | | float getFrequencyScaleFactor()(Code) | | Retrieve Frequency Scale Factor
frequency scale factor applied to sound's base frequency |
| getReflectionCoefficient | | float getReflectionCoefficient()(Code) | | Retrieve Reflective Coefficient
reflection coeff reflection/absorption factor applied to early reflections. |
| getReflectionDelay | | float getReflectionDelay()(Code) | | Retrieve Reflection Delay Time
reflection delay time |
| getReverbBounds | | Bounds getReverbBounds()(Code) | | Retrieve Revereration Delay Bounds volume
reverb bounds volume that defines the Reverberation space andindirectly the delay |
| getReverbCoefficient | | float getReverbCoefficient()(Code) | | Retrieve Reverb Coefficient
reverb coeff reflection/absorption factor applied to latereflections. |
| getReverbDelay | | float getReverbDelay()(Code) | | Retrieve Revereration Delay Time
reverb delay time between each order of reflection |
| getReverbOrder | | int getReverbOrder()(Code) | | Retrieve Reverberation Order of Reflections
reverb order number of times reflections added to reverb signal |
| getRolloff | | float getRolloff()(Code) | | Retrieve Attribute Gain Rolloff
rolloff atmospheric gain scale factor (changing speed of sound) |
| getVelocityScaleFactor | | float getVelocityScaleFactor()(Code) | | Retrieve Velocity ScaleFactor used in calculating Doppler Effect
velocity scale factor |
| setAttributeGain | | void setAttributeGain(float gain)(Code) | | Set Attribute Gain (amplitude)
Parameters:
gain - scale factor applied to amplitude |
| setDecayFilter | | void setDecayFilter(float decayFilter)(Code) | | Set Decay Filter
Parameters:
decayFilter - frequency referenced used in low-pass filtering |
| setDecayTime | | void setDecayTime(float decayTime)(Code) | | Set Decay Time
Parameters:
decayTime - length of time reverb takes to decay |
| setDensity | | void setDensity(float density)(Code) | | Set Reverb Density
Parameters:
density - ratio between min and max device density settings |
| setDiffusion | | void setDiffusion(float diffusion)(Code) | | Set Reverb Diffusion
Parameters:
diffusion - ratio between min and max device diffusion settings |
| setDistanceFilter | | synchronized void setDistanceFilter(Point2f[] attenuation)(Code) | | Set Distance Filter (based on distances and frequency cutoff)
Parameters:
attenuation - array of pairs defining distance frequency cutoff |
| setDistanceFilter | | synchronized void setDistanceFilter(float[] distance, float[] filter)(Code) | | Set Distance Filter (based on distances and frequency cutoff) using
separate arrays
Parameters:
distance - array containing distance values
Parameters:
filter - array containing low-pass frequency cutoff values |
| setFrequencyScaleFactor | | void setFrequencyScaleFactor(float frequencyScaleFactor)(Code) | | Set Frequency Scale Factor
Parameters:
frequencyScaleFactor - factor applied to sound's base frequency |
| setReflectionCoefficient | | void setReflectionCoefficient(float reflectionCoefficient)(Code) | | Set Reflective Coefficient
Parameters:
reflectionCoefficient - reflection/absorption factor applied to early reflections. |
| setReflectionDelay | | void setReflectionDelay(float reflectionDelay)(Code) | | Set Reflection Delay Time
Parameters:
reflectionDelay - time before the start of early (first order)reflections. |
| setReverbBounds | | synchronized void setReverbBounds(Bounds reverbVolume)(Code) | | Set Revereration Bounds
Parameters:
reverbVolume - bounds used to approximate reverb time. |
| setReverbCoefficient | | void setReverbCoefficient(float reverbCoefficient)(Code) | | Set Reverb Coefficient
Parameters:
reverbCoefficient - reflection/absorption factor applied to late reflections. |
| setReverbDelay | | void setReverbDelay(float reverbDelay)(Code) | | Set Revereration Delay Time
Parameters:
reverbDelay - time between each order of reflection |
| setReverbOrder | | void setReverbOrder(int reverbOrder)(Code) | | Set Reverberation Order of Reflections
Parameters:
reverbOrder - number of times reflections added to reverb signal |
| setRolloff | | void setRolloff(float rolloff)(Code) | | Set Attribute Gain Rolloff
Parameters:
rolloff - atmospheric gain scale factor (changing speed of sound) |
| setVelocityScaleFactor | | void setVelocityScaleFactor(float velocityScaleFactor)(Code) | | Set Velocity ScaleFactor used in calculating Doppler Effect
Parameters:
velocityScaleFactor - applied to velocity of sound in relation to listener |
| Fields inherited from javax.media.j3d.IndexedObject | int[][] listIdx(Code)(Java Doc)
|
|
|
|