ch.hevs.gdx2d.components.audio

Class MusicPlayer

java.lang.Object

ch.hevs.gdx2d.components.audio.MusicPlayer

All Implemented Interfaces:

Disposable

public class MusicPlayer
extends Object
implements Disposable

A class to stream music without loading it within gdx2d.

Version:

1.2

Author:

Pierre-André Mudry (mui), Christopher Metrailler (mei)

Field Summary

Fields

Modifier and Type	Field and Description
protected Music	s
protected float	volume

Constructor Summary

Constructors

Constructor and Description
MusicPlayer(String file) Constructor

Method Summary

Modifier and Type	Method and Description
void	dispose() Release resources when done working with them
protected void	finalize() Called when the object is destroyed
boolean	isLooping()
boolean	isPlaying()
void	loop() Plays the song in loop, repeating forever
void	play() Starts playing the song
void	setVolume(float v) Changes volume of the song played
void	stop() Stops playing the song

Methods inherited from class java.lang.Object

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

Field Detail

s

protected Music s

volume

protected float volume

Constructor Detail

MusicPlayer

public MusicPlayer(String file)

Constructor

Parameters:

file - The file to be played, using internal path representation

Method Detail

setVolume

public void setVolume(float v)

Changes volume of the song played

Parameters:

v - Should be between 0 and 1

play

public void play()

Starts playing the song

stop

public void stop()

Stops playing the song

isPlaying

public boolean isPlaying()

Returns:

True if the music is playing

isLooping

public boolean isLooping()

Returns:

True if the music is currently looping (aka playing repeatedly)

loop

public void loop()

Plays the song in loop, repeating forever

dispose

public void dispose()

Release resources when done working with them

Specified by:

dispose in interface Disposable

finalize

protected void finalize()
                 throws Throwable

Called when the object is destroyed

Overrides:

finalize in class Object

Throws:

Throwable