Java Doc for AudioEngine3D.java in  » 6.0-JDK-Modules » java-3d » com » sun » j3d » audioengines » 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 » com.sun.j3d.audioengines 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.j3d.audioengines.AudioEngine
      com.sun.j3d.audioengines.AudioEngine3D

All known Subclasses:   com.sun.j3d.audioengines.AudioEngine3DL2,
AudioEngine3D
abstract public class AudioEngine3D extends AudioEngine implements AudioDevice3D(Code)
The AudioEngine3D Class defines an audio output device that generates sound 'image' from high-level sound parameters passed to it during scene graph.

The methods in this class are meant to be optionally overridden by an extended class. This extended class would provice device specific code.

Error checking on all parameters passed to these methods is already explicitly being done by the Java 3D core code that calls these methods.

NOTE: AudioEngine developers should not subclass this class directly. Subclass AudioEngine3DL2 instead.



Field Summary
protected  AuralParametersattribs
    
protected  ViewcurrentView
    
protected  ArrayListsamples
    

Constructor Summary
public  AudioEngine3D(PhysicalEnvironment physicalEnvironment)
     Construct a new AudioEngine with the specified PhysicalEnvironment.

Method Summary
abstract public  voidclearSound(int index)
     Clear Sound.
public  AuralParametersgetAuralParameters()
    
public  intgetNumberOfChannelsUsed(int index)
     Get number of channels used by a particular sample on the audio device.
public  intgetNumberOfChannelsUsed(int index, boolean muteFlag)
     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  SamplegetSample(int index)
     Get specific sample from indexed sample list Checks for valid index before attempting to get sample from list.
public  longgetSampleDuration(int index)
     Get length of time a sample would play if allowed to play to completion.
protected  ArrayListgetSampleList()
    
public  intgetSampleListSize()
    
public  longgetStartTime(int index)
     Get time this sample begun playing on the audio device.
public  ViewgetView()
     Get reference to the current View object.
abstract public  voidmuteSample(int index)
     Mute sample.
abstract public  voidpauseSample(int index)
     Pause sample.
public  intprepareSound(int soundType, MediaContainer soundData)
     Prepare Sound in device.
public  voidsetAngularAttenuation(int index, int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff)
     Set angular attenuation arrays affecting angular amplitude attenuation and angular distance filtering.
public  voidsetDirection(int index, Vector3d direction)
     Set direction vector of sample.
public  voidsetDistanceFilter(int filterType, double[] dist, float[] filterCutoff)
     Set distance filter for current aural attribute applied to all samples.
public  voidsetDistanceGain(int index, double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor)
    
public  voidsetFrequencyScaleFactor(float scaleFactor)
     Set frequency scale factor for current aural attribute applied to all samples.
public  voidsetLoop(int index, int count)
     Set number of times sample is looped.
public  voidsetPosition(int index, Point3d position)
     Set location of sample.
public  voidsetReflectionCoefficient(float coefficient)
     Set reverberation surface reflection coefficient value for current aural attribute applied to all samples.
public  voidsetReverbDelay(float reverbDelay)
     Set reverberation delay time for current aural attribute applied to all samples.
public  voidsetReverbOrder(int reverbOrder)
     Set reverberation order for current aural attribute applied to all samples.
public  voidsetRolloff(float rolloff)
     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 scaleFactor)
     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)
    
abstract public  intstartSample(int index)
    
abstract public  intstopSample(int index)
    
abstract public  voidunmuteSample(int index)
     Unmute sample.
abstract public  voidunpauseSample(int index)
     Unpause sample.
abstract public  voidupdateSample(int index)
     Update sample.

Field Detail
attribs
protected AuralParameters attribs(Code)



currentView
protected View currentView(Code)
Current View sound is being rendered



samples
protected ArrayList samples(Code)




Constructor Detail
AudioEngine3D
public AudioEngine3D(PhysicalEnvironment physicalEnvironment)(Code)
Construct a new AudioEngine with the specified PhysicalEnvironment.
Parameters:
  physicalEnvironment - the physical environment object where wewant access to this device.




Method Detail
clearSound
abstract 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



getAuralParameters
public AuralParameters getAuralParameters()(Code)



getNumberOfChannelsUsed
public int getNumberOfChannelsUsed(int index)(Code)
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)
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.



getSample
public Sample getSample(int index)(Code)
Get specific sample from indexed sample list Checks for valid index before attempting to get sample from list.
Parameters:
  index - device specific reference number to device driver sample reference to sample; returns null if index out of range.
since:
   Java 3D 1.2.1



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



getSampleList
protected ArrayList getSampleList()(Code)
Get reference to the array list of samples reference to samples list



getSampleListSize
public int getSampleListSize()(Code)



getStartTime
public long getStartTime(int index)(Code)
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



getView
public View getView()(Code)
Get reference to the current View object. reference to current view object



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



pauseSample
abstract 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



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.
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.



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[] dist, float[] filterCutoff)(Code)
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)



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



setLoop
public void setLoop(int index, int count)(Code)
Set number of times sample is looped.
Parameters:
  index - device specific reference number to device driver sample
Parameters:
  count - number of times sample is repeated



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



setReflectionCoefficient
public void setReflectionCoefficient(float coefficient)(Code)
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.



setReverbDelay
public void setReverbDelay(float reverbDelay)(Code)
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)
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)
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 scaleFactor)(Code)
Set velocity scale factor for current aural attribute applied to all samples when Doppler is calculated.
Parameters:
  scaleFactor - 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)
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
abstract 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
abstract 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
abstract public void unmuteSample(int index)(Code)
Unmute sample.
Parameters:
  index - device specific reference number to device driver sample



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



updateSample
abstract public void updateSample(int index)(Code)
Update sample. Implies that some parameters affecting rendering have been modified.
Parameters:
  index - device specific reference number to device driver sample



Fields inherited from com.sun.j3d.audioengines.AudioEngine
float angleOffsetToSpeaker(Code)(Java Doc)
int audioPlaybackType(Code)(Java Doc)
int channelsAvailable(Code)(Java Doc)
float distanceToSpeaker(Code)(Java Doc)
int fileDescriptor(Code)(Java Doc)
int totalChannels(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.