Java Doc for JOALMixer.java in  » 6.0-JDK-Modules » java-3d » org » jdesktop » j3d » audioengines » joal » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » java 3d » org.jdesktop.j3d.audioengines.joal 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.j3d.audioengines.AudioEngine
      com.sun.j3d.audioengines.AudioEngine3D
         com.sun.j3d.audioengines.AudioEngine3DL2
            org.jdesktop.j3d.audioengines.joal.JOALMixer

JOALMixer
public class JOALMixer extends AudioEngine3DL2 implements AudioDevice,AudioDevice3D,AudioDevice3DL2(Code)
This class is a concrete implementation of AudioEngine3DL2 that uses the JOAL/OpenAL sound library to provide rendering of the Sound nodes in Java3D.
Notes:
1. getChannelsAvailable, getNumberOfChannelsUsed and getTotalChannels have not been implemented yet and thus if you try to play more sounds than the system has then they will not play. I am still trying to find out exactly how to implement these functions, possibly there is no limit when rendering sound using software rendering. Also at the moment I think I have limited the implementation to 64 sounds.
2. This implementation only plays wav files.
3. Other functions not implemented have the comment 'NOT IMPLEMENTED' in their respective JavaDoc comment, otherwise the function has been implemented.
4. Webstart demos are available at http://www.dutchie.net/joal/default.htm
Usage:
1. You must have the OpenAL drivers installed on your machine, these can be downloaded for Windows, MacOS, Linux at http://www.openal.org/downloads.html
2. You must have JOAL installed which can be downloaded from https://joal.dev.java.net/ . This includes joal.zip and the native dll/so for your selected platform.
3. To use in your application you simply use:
java -Dj3d.audiodevice=org.jdesktop.j3d.audioengines.joal.JOALMixer [your_application_class] and call viewer.createAudioDevice(); as normal.
author:
   David Grace (dave@dutchie.net)


Field Summary
final static  intADD_TO_LIST
    
final static  intSET_INTO_LIST
    
static  ALal
    
static  ALCalc
    

Constructor Summary
public  JOALMixer(PhysicalEnvironment physicalEnvironment)
    

Method Summary
public  voidclearSound(int index)
     Clear Sound.
public  booleanclose()
    
static  voidexitOpenAL()
     Unused code for to release resources created with the function above. Maybe useful later if the option of selecting which device on the machine is used.
public  floatgetAngleOffsetToSpeaker()
    
public  intgetAudioPlaybackType()
    
public  floatgetCenterEarToSpeaker()
    
public  intgetChannelsAvailable()
     NOT IMPLEMENTED
Query number of channels currently available for use by the returns number of sound channels currently available (number not being used by active sounds).
public  intgetChannelsUsedForSound(Sound sound)
     Query number of channels that would be used to render a particular sound node.
public  intgetNumberOfChannelsUsed(int index)
     NOT IMPLEMENTED
Get number of channels used by a particular sample on the audio device.
public  intgetNumberOfChannelsUsed(int index, boolean muteFlag)
     NOT IMPLEMENTED
Get number of channels that would be used by a particular sample on the audio device given the mute flag passed in as a parameter.
Parameters:
  index - device specific reference number to device driver sample
Parameters:
  muteFlag - denotes the mute state to assume while executing thisquery.
public  longgetSampleDuration(int index)
     Get length of time a sample would play if allowed to play to completion.
public  longgetStartTime(int index)
     NOT IMPLEMENTED
Get time this sample begun playing on the audio device.
public  intgetTotalChannels()
     NOT IMPLEMENTED
Query total number of channels available for sound rendering for this audio device.
static  intinitOpenAL()
     Unused code for more specific initialization of a sound device. Maybe useful later if the option of selecting which device on the machine is used.
public  booleaninitialize()
    
public  voidmuteSample(int index)
     Mute sample.
public  voidpause()
     NOT IMPLEMENTED
Pauses audio device engine without closing the device and associated threads.
public  voidpauseSample(int index)
     Pause sample.
public  intprepareSound(int soundType, MediaContainer soundData)
     Prepare Sound in device
Makes sound assessible to device - in this case attempts to load sound Stores sound type and data.
public  voidresume()
     NOT IMPLEMENTED
Resumes audio device engine (if previously paused) without reinitializing the device.
public  voidsetAngleOffsetToSpeaker(float angle)
    
public  voidsetAngularAttenuation(int index, int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff)
     Set angular attenuation arrays affecting angular amplitude attenuation and angular distance filtering
Angular attenuation in OpenAL/JOAL is determined by AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN
The region inside and AL_CONE_OUTER_ANGLE has its gain unchanged (AL_GAIN), the region inside AL_CONE_INNER_ANGLE and AL_CONE_OUTER_ANGLE has its gain between AL_GAIN and AL_CONE_OUTER_GAIN, and the region outside AL_CONE_OUTER_ANGLE has gain of AL_CONE_OUTER_GAIN
This function calculates the AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN from the given angular attenuation data from Java3D.
public  voidsetAudioPlaybackType(int type)
    
public  voidsetCenterEarToSpeaker(float distance)
    
public  voidsetDecayFilter(float frequencyCutoff)
     NOT IMPLEMENTED
Set reverb decay filter
This provides for frequencies above the given cutoff frequency to be attenuated during reverb decay at a different rate than frequencies below this value
Thus, defining a different reverb decay curve for frequencies above the cutoff value.
public  voidsetDecayTime(float time)
     NOT IMPLEMENTED
Set reverb decay time
Defines the reverberation decay curve.
public  voidsetDensity(float density)
     NOT IMPLEMENTED
Set reverb density
This defines the modal density (also referred to as 'spectral coloration')
The value of this parameter is expressed as a percent of the audio device's minimum-to-maximum values for this reverb parameter.
public  voidsetDiffusion(float diffusion)
     NOT IMPLEMENTED
Set reverb diffusion
This defines the echo dispersement (also referred to as 'echo density')
The value of this reverb parameter is expressed as a percent of the audio device's minimum-to-maximum values.
public  voidsetDirection(int index, Vector3d direction)
     Set direction vector of sample.
public  voidsetDistanceFilter(int filterType, double[] distance, float[] dist)
     NOT IMPLEMENTED
Set distance filter for current aural attribute applied to all samples.
public  voidsetDistanceGain(int index, double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor)
     Set elliptical distance attenuation arrays applied to sample amplitude
OPENAL/JOAL calculates the distance attenuation using its default model which is the inverse distance clamped model (equivalent to the IASIG I3DL2 distance model)
This is:
distance = max(distance, AL_REFERENCE_DISTANCE);
distance = max(distance, AL_MAX_DISTANCE);
gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE + AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE));
This function calculates the AL_REFERENCE_DISTANCE, AL_MAX_DISTANCE and AL_ROLLOFF_FACTOR from the given distance attenuation data from Java3D.
public  voidsetFrequencyScaleFactor(float frequencyScaleFactor)
     NOT IMPLEMENTED
Set frequency scale factor for current aural attribute applied to all samples.
public  voidsetGain(float scaleFactor)
     Set overall gain control of all sounds playing on the audio device.
public  voidsetLoop(int index, int count)
    
public  voidsetObstructionFilter(int index, float frequencyCutoff)
     NOT IMPLEMENTED
Set the obstruction filter control
This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an obstruction signal is being calculated, at a different rate than frequencies below this value.
public  voidsetObstructionGain(int index, float scaleFactor)
     NOT IMPLEMENTED
Set the obstruction gain control
This method allows for attenuating sound waves traveling between the sound source and the listener obstructed by objects
Direct sound signals/waves for obstructed sound source are attenuated but not indirect (reflected) waves.
public  voidsetOcclusionFilter(int index, float frequencyCutoff)
     NOT IMPLEMENTED
Set the occlusion filter control
This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an occluded signal is being calculated, at a different rate than frequencies below this value
There is no corresponding Core AuralAttributes method at this time.
public  voidsetOcclusionGain(int index, float scaleFactor)
     NOT IMPLEMENTED
Set the occlusion gain control
This method allows for attenuating sound waves traveling between the sound source and the listener occluded by objects
Both direct and indirect sound signals/waves for occluded sound sources are attenuated
There is no corresponding Core AuralAttributes method at this time.
public  voidsetPosition(int index, Point3d position)
     Set location of sample.
public  voidsetRateScaleFactor(int index, float scaleFactor)
     Set scale factor applied to sample playback rate for a particular sound associated with the audio device
Changing the device sample rate affects both the pitch and speed.
public  voidsetReflectionCoefficient(float coefficient)
     NOT IMPLEMENTED
Set reverberation surface reflection coefficient value for current aural attribute applied to all samples.
public  voidsetReflectionDelay(float reflectionDelay)
     NOT IMPLEMENTED Sets the early reflection delay time
In this form, the parameter specifies the delay time between each order of reflection (while reverberation is being rendered) explicitly given in milliseconds.
public  voidsetReverbCoefficient(float coefficient)
     NOT IMPLEMENTED
Set late reflection (referred to as 'reverb') attenuation.
public  voidsetReverbDelay(float reverbDelay)
     NOT IMPLEMENTED
Set reverberation delay time for current aural attribute applied to all samples.
public  voidsetReverbOrder(int reverbOrder)
     NOT IMPLEMENTED
Set reverberation order for current aural attribute applied to all samples.
public  voidsetRolloff(float rolloff)
     NOT IMPLEMENTED
Set rolloff value for current aural attribute applied to all samples.
public  voidsetSampleGain(int index, float scaleFactor)
     Set gain scale factor applied to sample.
public  voidsetVelocityScaleFactor(float velocityScaleFactor)
     NOT IMPLEMENTED
Set velocity scale factor for current aural attribute applied to all samples when Doppler is calculated.
public  voidsetView(View reference)
     Save a reference to the current View object.
public  voidsetVworldXfrm(int index, Transform3D trans)
    
public  intstartSample(int index)
    
public  intstopSample(int index)
    
public  voidunmuteSample(int index)
     Unmute sample.
public  voidunpauseSample(int index)
     Unpause sample.
public  voidupdateSample(int index)
     DOES NOTHING - not really needed when using JOAL
Update sample Implies that some parameters affecting rendering have been modified.

Field Detail
ADD_TO_LIST
final static int ADD_TO_LIST(Code)



SET_INTO_LIST
final static int SET_INTO_LIST(Code)



al
static AL al(Code)



alc
static ALC alc(Code)




Constructor Detail
JOALMixer
public JOALMixer(PhysicalEnvironment physicalEnvironment)(Code)
Creates a new instance of JOALMixer




Method Detail
clearSound
public void clearSound(int index)(Code)
Clear Sound. Removes/clears associated sound data with this sound source node
Parameters:
  index - device specific reference number to device driver sample



close
public boolean close()(Code)
NOT IMPLEMENTED
Code to close the device flag: true is closed sucessfully, false if error



exitOpenAL
static void exitOpenAL()(Code)
Unused code for to release resources created with the function above. Maybe useful later if the option of selecting which device on the machine is used. This would be used to close device.



getAngleOffsetToSpeaker
public float getAngleOffsetToSpeaker()(Code)
Get Angle Offset To Speaker returns value set as angle between vector to speaker and Z head axis



getAudioPlaybackType
public int getAudioPlaybackType()(Code)
Get Type of Audio Playback Output Device returns audio playback type to which sound is currently output



getCenterEarToSpeaker
public float getCenterEarToSpeaker()(Code)
Get Distance from Ear to Speaker returns value set as distance from listener's ear to speaker



getChannelsAvailable
public int getChannelsAvailable()(Code)
NOT IMPLEMENTED
Query number of channels currently available for use by the returns number of sound channels currently available (number not being used by active sounds).



getChannelsUsedForSound
public int getChannelsUsedForSound(Sound sound)(Code)
Query number of channels that would be used to render a particular sound node.
Parameters:
  sound - refenence to sound node that query to be performed onreturns number of sound channels used by a specific Sound node



getNumberOfChannelsUsed
public int getNumberOfChannelsUsed(int index)(Code)
NOT IMPLEMENTED
Get number of channels used by a particular sample on the audio device.
Parameters:
  index - device specific reference number to device driver sample number of channels currently being used by this sample.



getNumberOfChannelsUsed
public int getNumberOfChannelsUsed(int index, boolean muteFlag)(Code)
NOT IMPLEMENTED
Get number of channels that would be used by a particular sample on the audio device given the mute flag passed in as a parameter.
Parameters:
  index - device specific reference number to device driver sample
Parameters:
  muteFlag - denotes the mute state to assume while executing thisquery. This mute value does not have to match the current mute stateof the sample. number of channels that would be used by this sample if itwere playing.



getSampleDuration
public long getSampleDuration(int index)(Code)
Get length of time a sample would play if allowed to play to completion.
Parameters:
  index - device specific reference number to device driver sample length of sample in milliseconds



getStartTime
public long getStartTime(int index)(Code)
NOT IMPLEMENTED
Get time this sample begun playing on the audio device.
Parameters:
  index - device specific reference number to device driver sample system clock time sample started



getTotalChannels
public int getTotalChannels()(Code)
NOT IMPLEMENTED
Query total number of channels available for sound rendering for this audio device. returns number of maximum sound channels you can run with this library/device-driver.



initOpenAL
static int initOpenAL()(Code)
Unused code for more specific initialization of a sound device. Maybe useful later if the option of selecting which device on the machine is used. At the moment it is the 'default' device returned by OpenAL/JOAL that is used.



initialize
public boolean initialize()(Code)
Code to initialize the device flag: true is initialized sucessfully, false if error



muteSample
public void muteSample(int index)(Code)
Mute sample.
Parameters:
  index - device specific reference number to device driver sample



pause
public void pause()(Code)
NOT IMPLEMENTED
Pauses audio device engine without closing the device and associated threads. Causes all cached sounds to be paused and all streaming sounds to be stopped.



pauseSample
public void pauseSample(int index)(Code)
Pause sample.
Parameters:
  index - device specific reference number to device driver sample



prepareSound
public int prepareSound(int soundType, MediaContainer soundData)(Code)
Prepare Sound in device
Makes sound assessible to device - in this case attempts to load sound Stores sound type and data.
Parameters:
  soundType - denotes type of sound: Background, Point or Cone
Parameters:
  soundData - descrition of sound source data index into sample vector of Sample object for sound



resume
public void resume()(Code)
NOT IMPLEMENTED
Resumes audio device engine (if previously paused) without reinitializing the device. Causes all paused cached sounds to be resumed and all streaming sounds restarted.



setAngleOffsetToSpeaker
public void setAngleOffsetToSpeaker(float angle)(Code)
Set Angle Offset To Speaker
Parameters:
  angle - in radian between head coordinate Z axis and vector to speaker



setAngularAttenuation
public void setAngularAttenuation(int index, int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff)(Code)
Set angular attenuation arrays affecting angular amplitude attenuation and angular distance filtering
Angular attenuation in OpenAL/JOAL is determined by AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN
The region inside and AL_CONE_OUTER_ANGLE has its gain unchanged (AL_GAIN), the region inside AL_CONE_INNER_ANGLE and AL_CONE_OUTER_ANGLE has its gain between AL_GAIN and AL_CONE_OUTER_GAIN, and the region outside AL_CONE_OUTER_ANGLE has gain of AL_CONE_OUTER_GAIN
This function calculates the AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN from the given angular attenuation data from Java3D.

Parameters:
  index - device specific reference number to device driver sample
Parameters:
  filterType - denotes type of filtering (on no filtering) appliedto sample.
Parameters:
  angle - array containing angular distances from sound axis
Parameters:
  attenuationScaleFactor - array containing gain scale factor
Parameters:
  filterCutoff - array containing filter cutoff frequencies.The filter values for each tuples can be set to Sound.NO_FILTER.



setAudioPlaybackType
public void setAudioPlaybackType(int type)(Code)
Set Type of Audio Playback physical transducer(s) sound is output to
Valid types are HEADPHONE, MONO_SPEAKER, STEREO_SPEAKERS
Parameters:
  type - of audio output device



setCenterEarToSpeaker
public void setCenterEarToSpeaker(float distance)(Code)
Set Distance from the Center Ear to a Speaker
Parameters:
  distance - from the center ear and to the speaker



setDecayFilter
public void setDecayFilter(float frequencyCutoff)(Code)
NOT IMPLEMENTED
Set reverb decay filter
This provides for frequencies above the given cutoff frequency to be attenuated during reverb decay at a different rate than frequencies below this value
Thus, defining a different reverb decay curve for frequencies above the cutoff value.
Parameters:
  frequencyCutoff - value of frequencies in Hertz above which alow-pass filter is applied.
See Also:   AuralAttributes.setDecayFilter



setDecayTime
public void setDecayTime(float time)(Code)
NOT IMPLEMENTED
Set reverb decay time
Defines the reverberation decay curve.
Parameters:
  time - decay time in milliseconds
See Also:   AuralAttributes.setDecayTime



setDensity
public void setDensity(float density)(Code)
NOT IMPLEMENTED
Set reverb density
This defines the modal density (also referred to as 'spectral coloration')
The value of this parameter is expressed as a percent of the audio device's minimum-to-maximum values for this reverb parameter.
Parameters:
  density - reverb density expressed as a percentage,within the range of 0.0 and 1.0
See Also:   AuralAttributes.setDensity



setDiffusion
public void setDiffusion(float diffusion)(Code)
NOT IMPLEMENTED
Set reverb diffusion
This defines the echo dispersement (also referred to as 'echo density')
The value of this reverb parameter is expressed as a percent of the audio device's minimum-to-maximum values.
Parameters:
  diffusion - percentage expressed within the range of 0.0 and 1.0
See Also:   AuralAttributes.setDiffusion



setDirection
public void setDirection(int index, Vector3d direction)(Code)
Set direction vector of sample.
Parameters:
  index - device specific reference number to device driver sample
Parameters:
  direction - vector in virtual world coordinate.



setDistanceFilter
public void setDistanceFilter(int filterType, double[] distance, float[] dist)(Code)
NOT IMPLEMENTED
Set distance filter for current aural attribute applied to all samples.
Parameters:
  filterType - denotes type of filtering (on no filtering) appliedto all sample based on distance between listener and sound.
Parameters:
  dist - is an attenuation array of distance and low-pass filter values.



setDistanceGain
public void setDistanceGain(int index, double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor)(Code)
Set elliptical distance attenuation arrays applied to sample amplitude
OPENAL/JOAL calculates the distance attenuation using its default model which is the inverse distance clamped model (equivalent to the IASIG I3DL2 distance model)
This is:
distance = max(distance, AL_REFERENCE_DISTANCE);
distance = max(distance, AL_MAX_DISTANCE);
gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE + AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE));
This function calculates the AL_REFERENCE_DISTANCE, AL_MAX_DISTANCE and AL_ROLLOFF_FACTOR from the given distance attenuation data from Java3D.

Parameters:
  index - device specific reference number to device driver sample
Parameters:
  frontDistance - defines an array of distance along the position axisthru which ellipses pass
Parameters:
  frontAttenuationScaleFactor - gain scale factors
Parameters:
  backDistance - defines an array of distance along the negative axisthru which ellipses pass
Parameters:
  backAttenuationScaleFactor - gain scale factors



setFrequencyScaleFactor
public void setFrequencyScaleFactor(float frequencyScaleFactor)(Code)
NOT IMPLEMENTED
Set frequency scale factor for current aural attribute applied to all samples.
Parameters:
  frequencyScaleFactor - frequency scale factor applied to samples normalplayback rate.



setGain
public void setGain(float scaleFactor)(Code)
Set overall gain control of all sounds playing on the audio device.
Parameters:
  scaleFactor - scale factor applied to calculated amplitudes forall sounds playing on this device



setLoop
public void setLoop(int index, int count)(Code)
NOT IMPLEMENTED COMPLETELY
Set number of times sample is looped
Works for values 0 (no loop) and (-1) infinite loop but not for a fix number of loops (>1)

Parameters:
  index - device specific reference number to device driver sample
Parameters:
  count - number of times sample is repeated



setObstructionFilter
public void setObstructionFilter(int index, float frequencyCutoff)(Code)
NOT IMPLEMENTED
Set the obstruction filter control
This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an obstruction signal is being calculated, at a different rate than frequencies below this value. There is no corresponding Core AuralAttributes method at this time.
Parameters:
  index - device specific reference to device driver sample
Parameters:
  frequencyCutoff - value of frequencies in Hertz above which alow-pass filter is applied.



setObstructionGain
public void setObstructionGain(int index, float scaleFactor)(Code)
NOT IMPLEMENTED
Set the obstruction gain control
This method allows for attenuating sound waves traveling between the sound source and the listener obstructed by objects
Direct sound signals/waves for obstructed sound source are attenuated but not indirect (reflected) waves. There is no corresponding Core AuralAttributes method at this time.
Parameters:
  index - device specific reference to device driver sample
Parameters:
  scaleFactor - non-negative factor applied to direct sound gain



setOcclusionFilter
public void setOcclusionFilter(int index, float frequencyCutoff)(Code)
NOT IMPLEMENTED
Set the occlusion filter control
This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an occluded signal is being calculated, at a different rate than frequencies below this value
There is no corresponding Core AuralAttributes method at this time.
Parameters:
  index - device specific reference to device driver sample
Parameters:
  frequencyCutoff - value of frequencies in Hertz above which alow-pass filter is applied.



setOcclusionGain
public void setOcclusionGain(int index, float scaleFactor)(Code)
NOT IMPLEMENTED
Set the occlusion gain control
This method allows for attenuating sound waves traveling between the sound source and the listener occluded by objects
Both direct and indirect sound signals/waves for occluded sound sources are attenuated
There is no corresponding Core AuralAttributes method at this time.
Parameters:
  index - device specific reference to device driver sample
Parameters:
  scaleFactor - non-negative factor applied to direct sound gain



setPosition
public void setPosition(int index, Point3d position)(Code)
Set location of sample.
Parameters:
  index - device specific reference number to device driver sample
Parameters:
  position - point location in virtual world coordinate of sample



setRateScaleFactor
public void setRateScaleFactor(int index, float scaleFactor)(Code)
Set scale factor applied to sample playback rate for a particular sound associated with the audio device
Changing the device sample rate affects both the pitch and speed. This scale factor is applied to ALL sound types
Changes (scales) the playback rate of a sound independent of Doppler rate changes.
Parameters:
  index - device specific reference to device driver sample
Parameters:
  scaleFactor - non-negative factor applied to calculatedamplitudes for all sounds playing on this device
See Also:   Sound.setRateScaleFactor



setReflectionCoefficient
public void setReflectionCoefficient(float coefficient)(Code)
NOT IMPLEMENTED
Set reverberation surface reflection coefficient value for current aural attribute applied to all samples.
Parameters:
  coefficient - applied to amplitude of reverbation added at eachiteration of reverb processing.



setReflectionDelay
public void setReflectionDelay(float reflectionDelay)(Code)
NOT IMPLEMENTED Sets the early reflection delay time
In this form, the parameter specifies the delay time between each order of reflection (while reverberation is being rendered) explicitly given in milliseconds.
Parameters:
  reflectionDelay - time between each order of early reflection
See Also:   AuralAttributes.setReflectionDelay



setReverbCoefficient
public void setReverbCoefficient(float coefficient)(Code)
NOT IMPLEMENTED
Set late reflection (referred to as 'reverb') attenuation. This scale factor is applied to iterative, indistinguishable late reflections that constitute the tail of reverberated sound in the aural environment
This parameter, along with the early reflection coefficient, defines the reflective/absorptive characteristic of the surfaces in the current listening region.
Parameters:
  coefficient - late reflection attenuation factor
See Also:   AuralAttributes.setReverbCoefficient



setReverbDelay
public void setReverbDelay(float reverbDelay)(Code)
NOT IMPLEMENTED
Set reverberation delay time for current aural attribute applied to all samples.
Parameters:
  reverbDelay - amount of time in millisecond between eachiteration of reverb processing.



setReverbOrder
public void setReverbOrder(int reverbOrder)(Code)
NOT IMPLEMENTED
Set reverberation order for current aural attribute applied to all samples.
Parameters:
  reverbOrder - number of times reverb process loop is iterated.



setRolloff
public void setRolloff(float rolloff)(Code)
NOT IMPLEMENTED
Set rolloff value for current aural attribute applied to all samples.
Parameters:
  rolloff - scale factor applied to standard speed of sound.



setSampleGain
public void setSampleGain(int index, float scaleFactor)(Code)
Set gain scale factor applied to sample.
Parameters:
  index - device specific reference number to device driver sample
Parameters:
  scaleFactor - floating point multiplier applied to sample amplitude



setVelocityScaleFactor
public void setVelocityScaleFactor(float velocityScaleFactor)(Code)
NOT IMPLEMENTED
Set velocity scale factor for current aural attribute applied to all samples when Doppler is calculated.
Parameters:
  velocityScaleFactor - scale factor applied to postional samples'listener-to-soundSource velocity.playback rate.



setView
public void setView(View reference)(Code)
Save a reference to the current View object.
Parameters:
  reference - to current view object



setVworldXfrm
public void setVworldXfrm(int index, Transform3D trans)(Code)
DOES NOTHING - does not need to do anything special for JOAL
Set the transform for local to virtual world coordinate space
Parameters:
  index - device specific reference number to device driver sample
Parameters:
  trans - is a reference to virtual world composite transform



startSample
public int startSample(int index)(Code)
Start sample playing on audio device
Parameters:
  index - device specific reference number to device driver sample status: < 0 denotes an error



stopSample
public int stopSample(int index)(Code)
Stop sample playing on audio device
Parameters:
  index - device specific reference number to device driver sample status: < 0 denotes an error



unmuteSample
public void unmuteSample(int index)(Code)
Unmute sample.
Parameters:
  index - device specific reference number to device driver sample



unpauseSample
public void unpauseSample(int index)(Code)
Unpause sample.
Parameters:
  index - device specific reference number to device driver sample



updateSample
public void updateSample(int index)(Code)
DOES NOTHING - not really needed when using JOAL
Update sample Implies that some parameters affecting rendering have been modified.
Parameters:
  index - device specific reference number to device driver sample



Methods inherited from com.sun.j3d.audioengines.AudioEngine3DL2
abstract public void pause()(Code)(Java Doc)
abstract public void resume()(Code)(Java Doc)
public void setDecayFilter(float frequencyCutoff)(Code)(Java Doc)
public void setDecayTime(float time)(Code)(Java Doc)
public void setDensity(float density)(Code)(Java Doc)
public void setDiffusion(float diffusion)(Code)(Java Doc)
abstract public void setGain(float scaleFactor)(Code)(Java Doc)
public void setObstructionFilter(int index, float frequencyCutoff)(Code)(Java Doc)
public void setObstructionGain(int index, float scaleFactor)(Code)(Java Doc)
public void setOcclusionFilter(int index, float frequencyCutoff)(Code)(Java Doc)
public void setOcclusionGain(int index, float scaleFactor)(Code)(Java Doc)
public void setRateScaleFactor(int index, float scaleFactor)(Code)(Java Doc)
public void setReflectionDelay(float reflectionDelay)(Code)(Java Doc)
public void setReverbCoefficient(float coefficient)(Code)(Java Doc)

Fields inherited from com.sun.j3d.audioengines.AudioEngine3D
protected AuralParameters attribs(Code)(Java Doc)
protected View currentView(Code)(Java Doc)
protected ArrayList samples(Code)(Java Doc)

Methods inherited from com.sun.j3d.audioengines.AudioEngine3D
abstract public void clearSound(int index)(Code)(Java Doc)
public AuralParameters getAuralParameters()(Code)(Java Doc)
public int getNumberOfChannelsUsed(int index)(Code)(Java Doc)
public int getNumberOfChannelsUsed(int index, boolean muteFlag)(Code)(Java Doc)
public Sample getSample(int index)(Code)(Java Doc)
public long getSampleDuration(int index)(Code)(Java Doc)
protected ArrayList getSampleList()(Code)(Java Doc)
public int getSampleListSize()(Code)(Java Doc)
public long getStartTime(int index)(Code)(Java Doc)
public View getView()(Code)(Java Doc)
abstract public void muteSample(int index)(Code)(Java Doc)
abstract public void pauseSample(int index)(Code)(Java Doc)
public int prepareSound(int soundType, MediaContainer soundData)(Code)(Java Doc)
public void setAngularAttenuation(int index, int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff)(Code)(Java Doc)
public void setDirection(int index, Vector3d direction)(Code)(Java Doc)
public void setDistanceFilter(int filterType, double[] dist, float[] filterCutoff)(Code)(Java Doc)
public void setDistanceGain(int index, double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor)(Code)(Java Doc)
public void setFrequencyScaleFactor(float scaleFactor)(Code)(Java Doc)
public void setLoop(int index, int count)(Code)(Java Doc)
public void setPosition(int index, Point3d position)(Code)(Java Doc)
public void setReflectionCoefficient(float coefficient)(Code)(Java Doc)
public void setReverbDelay(float reverbDelay)(Code)(Java Doc)
public void setReverbOrder(int reverbOrder)(Code)(Java Doc)
public void setRolloff(float rolloff)(Code)(Java Doc)
public void setSampleGain(int index, float scaleFactor)(Code)(Java Doc)
public void setVelocityScaleFactor(float scaleFactor)(Code)(Java Doc)
public void setView(View reference)(Code)(Java Doc)
public void setVworldXfrm(int index, Transform3D trans)(Code)(Java Doc)
abstract public int startSample(int index)(Code)(Java Doc)
abstract public int stopSample(int index)(Code)(Java Doc)
abstract public void unmuteSample(int index)(Code)(Java Doc)
abstract public void unpauseSample(int index)(Code)(Java Doc)
abstract public void updateSample(int index)(Code)(Java Doc)

Methods inherited from com.sun.j3d.audioengines.AudioEngine
abstract public boolean close()(Code)(Java Doc)
public float getAngleOffsetToSpeaker()(Code)(Java Doc)
public int getAudioPlaybackType()(Code)(Java Doc)
public float getCenterEarToSpeaker()(Code)(Java Doc)
public int getChannelsAvailable()(Code)(Java Doc)
public int getChannelsUsedForSound(Sound sound)(Code)(Java Doc)
public int getTotalChannels()(Code)(Java Doc)
abstract public boolean initialize()(Code)(Java Doc)
public void setAngleOffsetToSpeaker(float angle)(Code)(Java Doc)
public void setAudioPlaybackType(int type)(Code)(Java Doc)
public void setCenterEarToSpeaker(float distance)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.