org.mini2Dx.core.audio

Interface Music

All Superinterfaces:

org.mini2Dx.gdx.utils.Disposable

All Known Implementing Classes:

AndroidMini2DxMusic, LibgdxMusic

public interface Music
extends org.mini2Dx.gdx.utils.Disposable

Base interface for Music stream-based playback

Method Summary

Modifier and Type	Method and Description
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	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 interface org.mini2Dx.gdx.utils.Disposable

dispose

Method Detail

getId

long getId()

Returns the unique ID for this instance

Returns:

The unique ID

play

void play()

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

pause

void pause()

Pauses the playback if it is currently playing

stop

void stop()

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

isPlaying

boolean isPlaying()

Returns if the music is playing

Returns:

True if playing

setLooping

void setLooping(boolean isLooping)

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

Parameters:

isLooping - True if the music should loop.

isLooping

boolean isLooping()

Returns if the music will loop

Returns:

True if looping

setVolume

void setVolume(float volume)

Sets the volume of the music

Parameters:

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

getVolume

float getVolume()

Returns the volume of the music

Returns:

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

getPosition

float getPosition()

Returns the playback position

Returns:

The position in seconds