From 6f6b1239365d6e202237416a15388d8b53f3fdf4 Mon Sep 17 00:00:00 2001 From: "rem..om" Date: Sat, 12 Oct 2013 12:01:21 +0000 Subject: [PATCH] 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 --- engine/src/core/com/jme3/audio/AudioNode.java | 21 +++++++++++-------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/engine/src/core/com/jme3/audio/AudioNode.java b/engine/src/core/com/jme3/audio/AudioNode.java index 5ee74dbd5..0e75db9fe 100644 --- a/engine/src/core/com/jme3/audio/AudioNode.java +++ b/engine/src/core/com/jme3/audio/AudioNode.java @@ -45,15 +45,18 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * An AudioNode is used in jME3 for playing audio files. - *
- * First, an {@link AudioNode} is loaded from file, and then assigned - * to an audio node for playback. Once the audio node is attached to the - * scene, its location will influence the position it is playing from relative - * to the {@link Listener}. - *
- * An audio node can also play in "headspace", meaning its location - * or velocity does not influence how it is played. + * An AudioNode is a scene Node which can play audio assets. + * + * An AudioNode is either positional or ambient, with positional being the + * default. Once a positional node is attached to the scene, its location and + * velocity relative to the {@link Listener} affect how it sounds when played. + * Positional nodes can only play monoaural (single-channel) assets, not stereo + * ones. + * + * 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 * {@link AudioNode#setPositional(boolean) }. *