org.mini2Dx.libgdx.audio

Class LibgdxMusic

java.lang.Object

org.mini2Dx.libgdx.audio.LibgdxMusic

All Implemented Interfaces:

com.badlogic.gdx.audio.Music.OnCompletionListener, Music, org.mini2Dx.gdx.utils.Disposable

public class LibgdxMusic
extends java.lang.Object
implements Music, com.badlogic.gdx.audio.Music.OnCompletionListener

Field Summary

Fields

Modifier and Type	Field and Description
LibgdxAudio	audio
long	id
com.badlogic.gdx.audio.Music	music

Constructor Summary

Constructors

Constructor and Description
LibgdxMusic(LibgdxAudio audio, com.badlogic.gdx.audio.Music music)

Method Summary

Modifier and Type	Method and Description
void	dispose()
long	getId() Returns the unique ID for this instance
float	getPosition() Returns the playback position
float	getVolume() Returns the volume of the music
boolean	isLooping() Returns if the music will loop
boolean	isPlaying() Returns if the music is playing
void	onCompletion(com.badlogic.gdx.audio.Music music)
void	pause() Pauses the playback if it is currently playing
void	play() Starts playing the music stream.
void	setLooping(boolean isLooping) Sets if the music should loop.
void	setVolume(float volume) Sets the volume of the music
void	stop() Stops the playback if it is paused or currently playing.

Methods inherited from class java.lang.Object

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

Field Detail

id

public final long id

music

public final com.badlogic.gdx.audio.Music music

audio

public final LibgdxAudio audio

Constructor Detail

LibgdxMusic

public LibgdxMusic(LibgdxAudio audio,
                   com.badlogic.gdx.audio.Music music)

Method Detail

getId

public long getId()

Description copied from interface: Music

Returns the unique ID for this instance

Specified by:

getId in interface Music

Returns:

The unique ID

play

public void play()

Description copied from interface: Music

Starts playing the music stream. If the stream was paused, it will resume playing. If the stream was finished or stopped, it will restart.

Specified by:

play in interface Music

pause

public void pause()

Description copied from interface: Music

Pauses the playback if it is currently playing

Specified by:

pause in interface Music

stop

public void stop()

Description copied from interface: Music

Stops the playback if it is paused or currently playing. The next call to Music.play() will start playback from the beginning.

Specified by:

stop in interface Music

isPlaying

public boolean isPlaying()

Description copied from interface: Music

Returns if the music is playing

Specified by:

isPlaying in interface Music

Returns:

True if playing

setLooping

public void setLooping(boolean isLooping)

Description copied from interface: Music

Sets if the music should loop. Can be called anytime.

Specified by:

setLooping in interface Music

Parameters:

isLooping - True if the music should loop.

isLooping

public boolean isLooping()

Description copied from interface: Music

Returns if the music will loop

Specified by:

isLooping in interface Music

Returns:

True if looping

setVolume

public void setVolume(float volume)

Description copied from interface: Music

Sets the volume of the music

Specified by:

setVolume in interface Music

Parameters:

volume - A value between 0.0 and 1.0 where 0.0 is silent and 1.0 is maximum volume.

getVolume

public float getVolume()

Description copied from interface: Music

Returns the volume of the music

Specified by:

getVolume in interface Music

Returns:

A value between 0.0 and 1.0 where 0.0 is silent and 1.0 is maximum volume.

getPosition

public float getPosition()

Description copied from interface: Music

Returns the playback position

Specified by:

getPosition in interface Music

Returns:

The position in seconds

dispose

public void dispose()

Specified by:

dispose in interface org.mini2Dx.gdx.utils.Disposable

onCompletion

public void onCompletion(com.badlogic.gdx.audio.Music music)

Specified by:

onCompletion in interface com.badlogic.gdx.audio.Music.OnCompletionListener