Changed the javadoc of AudioNode to clarify its behaviour when it's positional or not and regarding mono and stereo format audio sources

git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@10831 75d07b2b-3a1a-0410-a2c5-0572b91ccdca
experimental
rem..om 11 years ago
parent 596b5a0060
commit 6f6b123936
  1. 21
      engine/src/core/com/jme3/audio/AudioNode.java

@ -45,15 +45,18 @@ import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
/** /**
* An <code>AudioNode</code> is used in jME3 for playing audio files. * An <code>AudioNode</code> is a scene Node which can play audio assets.
* <br/> *
* First, an {@link AudioNode} is loaded from file, and then assigned * An AudioNode is either positional or ambient, with positional being the
* to an audio node for playback. Once the audio node is attached to the * default. Once a positional node is attached to the scene, its location and
* scene, its location will influence the position it is playing from relative * velocity relative to the {@link Listener} affect how it sounds when played.
* to the {@link Listener}. * Positional nodes can only play monoaural (single-channel) assets, not stereo
* <br/> * ones.
* An audio node can also play in "headspace", meaning its location *
* or velocity does not influence how it is played. * An ambient AudioNode plays in "headspace", meaning that the node's location
* and velocity do not affect how it sounds when played. Ambient audio nodes can
* play stereo assets.
*
* The "positional" property of an AudioNode can be set via * The "positional" property of an AudioNode can be set via
* {@link AudioNode#setPositional(boolean) }. * {@link AudioNode#setPositional(boolean) }.
* *

Loading…
Cancel
Save