33 package com.jme3.audio;
49  * An <code>AudioNode</code> is used in jME3 for playing audio files.
52  * to an audio node for playback. Once the audio node is attached to the 
56  * An audio node can also play in "headspace", meaning its location
87      * <code>Status</code> indicates the current status of the audio node.
91          * The audio node is currently playing. This will be set if
97          * The audio node is currently paused.
102          * The audio node is currently stopped.
104          * or the audio has reached the end of the file.
110      * Creates a new <code>AudioNode</code> without any audio data set.
116      * Creates a new <code>AudioNode</code> without any audio data set.
118      * @param audioRenderer The audio renderer to use for playing. Cannot be null.
128      * @param audioRenderer The audio renderer to use for playing. Cannot be null.
129      * @param audioData The audio data contains the audio track to play.
130      * @param audioKey The audio key that was used to load the AudioData
141      * @param audioData The audio data contains the audio track to play.
142      * @param audioKey The audio key that was used to load the AudioData
149      * Creates a new <code>AudioNode</code> with the given audio file.
151      * @param audioRenderer The audio renderer to use for playing. Cannot be null.
152      * @param assetManager The asset manager to use to load the audio file
153      * @param name The filename of the audio file
154      * @param stream If true, the audio will be streamed gradually from disk, 
157      * the stream cache is used. When enabled, the audio stream will
169      * Creates a new <code>AudioNode</code> with the given audio file.
171      * @param assetManager The asset manager to use to load the audio file
172      * @param name The filename of the audio file
173      * @param stream If true, the audio will be streamed gradually from disk, 
176      * the stream cache is used. When enabled, the audio stream will
186      * Creates a new <code>AudioNode</code> with the given audio file.
188      * @param audioRenderer The audio renderer to use for playing. Cannot be null.
189      * @param assetManager The asset manager to use to load the audio file
190      * @param name The filename of the audio file
191      * @param stream If true, the audio will be streamed gradually from disk, 
201      * Creates a new <code>AudioNode</code> with the given audio file.
203      * @param assetManager The asset manager to use to load the audio file
204      * @param name The filename of the audio file
205      * @param stream If true, the audio will be streamed gradually from disk, 
213      * Creates a new <code>AudioNode</code> with the given audio file.
215      * @param audioRenderer The audio renderer to use for playing. Cannot be null.
216      * @param assetManager The asset manager to use to load the audio file
217      * @param name The filename of the audio file
226      * Creates a new <code>AudioNode</code> with the given audio file.
228      * @param assetManager The asset manager to use to load the audio file
229      * @param name The filename of the audio file
238             throw new IllegalStateException( "No audio renderer available, make sure call is being performed on render thread." );
243      * Start playing the audio.
250      * Start playing an instance of this audio. This method can be used
260      * Stop playing the audio that was started with {@link AudioNode#play() }.
267      * Pause the audio that was started with {@link AudioNode#play() }.
293      * @see AudioNode#setDryFilter(com.jme3.audio.Filter) 
300      * Set the dry filter to use for this audio node.
303      * the dry filter will only influence the "dry" portion of the audio, 
318      * Set the audio data to use for the audio. Note that this method
319      * can only be called once, if for example the audio node was initialized
322      * @param audioData The audio data contains the audio track to play.
323      * @param audioKey The audio key that was used to load the AudioData
336      * {@link AudioNode#setAudioData(com.jme3.audio.AudioData, com.jme3.audio.AudioKey) }
337      * or any of the constructors that initialize the audio data.
344      * @return The {@link Status} of the audio node. 
360      * @return True if the audio will keep looping after it is done playing,
369      * Set the looping mode for the audio node. The default is false.
371      * @param loop True if the audio should keep looping after it is done playing.
380      * @return The pitch of the audio, also the speed of playback.
389      * Set the pitch of the audio, also the speed of playback.
406      * @return The volume of this audio node.
415      * Set the volume of this audio node.
461      * @return The velocity of the audio node.
470      * Set the velocity of the audio node. The velocity is expected
471      * to be in meters. Does nothing if the audio node is not positional.
492      * Set to true to enable reverberation effects for this audio node.
493      * Does nothing if the audio node is not positional.
495      * When enabled, the audio environment set with 
496      * {@link AudioRenderer#setEnvironment(com.jme3.audio.Environment) }
497      * will apply a reverb effect to the audio playing from this audio node.
508      * @return Filter for the reverberations of this audio node.
510      * @see AudioNode#setReverbFilter(com.jme3.audio.Filter) 
517      * Set the reverb filter for this audio node.
520      * of the audio node playing. This only has an effect if
524      * @see AudioNode#setDryFilter(com.jme3.audio.Filter)
533      * @return Max distance for this audio node.
542      * Set the maximum distance for the attenuation of the audio node.
543      * Does nothing if the audio node is not positional.
545      * The maximum distance is the distance beyond which the audio
567      * @return The reference playing distance for the audio node.
576      * Set the reference playing distance for the audio node.
577      * Does nothing if the audio node is not positional.
580      * audio node will be exactly half of its volume.
596      * @return True if the audio node is directional
605      * Set the audio node to be directional.
606      * Does nothing if the audio node is not positional.
610      * to set the audio node's direction.
612      * @param directional If the audio node is directional
621      * @return The direction of this audio node.
630      * Set the direction of this audio node.
631      * Does nothing if the audio node is not directional.
643      * @return The directional audio node, cone inner angle.
652      * Set the directional audio node cone inner angle.
653      * Does nothing if the audio node is not directional.
664      * @return The directional audio node, cone outer angle.
673      * Set the directional audio node cone outer angle.
674      * Does nothing if the audio node is not directional.
685      * @return True if the audio node is positional.
694      * Set the audio node as positional.
696      * audio nodes. Set to false if the audio node should play in "headspace".
698      * @param positional True if the audio node should be positional, otherwise
792                 Logger.getLogger(AudioNode.class.getName()).log(Level.FINE, "Cannot locate {0} for audio node {1}", new Object[]{audioKey, key});

Indexes created Fri Jan 08 05:29:00 CET 2016