org.mini2Dx.core.audio

Class CrossFadingMusicLoop

java.lang.Object

org.mini2Dx.core.audio.CrossFadingMusicLoop

public class CrossFadingMusicLoop
extends java.lang.Object

Implements a loopable music track and crossfades into itself. Note: It is required to call update() each frame when using this object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CrossFadingMusicLoop.ScheduleStop

Constructor Summary

Constructors

Constructor and Description
CrossFadingMusicLoop(com.badlogic.gdx.files.FileHandle musicFile, float crossfadeTime, float crossfadeDuration) Constructor

Method Summary

Modifier and Type	Method and Description
void	dispose() Cleans up resources.
void	fadeOut(float duration)
void	fadeOutAndStop(float duration)
boolean	isPlaying() Returns if the loop is playing
void	play() Starts playing the loop
void	setVolume(float volume)
void	stop() Stops playing the loop
void	update() Updates the crossfading of the track

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrossFadingMusicLoop

public CrossFadingMusicLoop(com.badlogic.gdx.files.FileHandle musicFile,
                            float crossfadeTime,
                            float crossfadeDuration)

Constructor

Parameters:

musicFile - The FileHandle for the music to be looped

crossfadeTime - The time (in seconds) at which the crossfade begins at the end of the track

crossfadeDuration - The duration of the crossfade in seconds

Method Detail

update

public void update()

Updates the crossfading of the track

play

public void play()

Starts playing the loop

stop

public void stop()

Stops playing the loop

isPlaying

public boolean isPlaying()

Returns if the loop is playing

Returns:

True if playing

dispose

public void dispose()

Cleans up resources. To be called when this instance is no longer needed.

setVolume

public void setVolume(float volume)

fadeOut

public void fadeOut(float duration)

fadeOutAndStop

public void fadeOutAndStop(float duration)