Package com.badlogic.gdx.backends.lwjgl3.audio

Class OpenALMusic

java.lang.Object

com.badlogic.gdx.backends.lwjgl3.audio.OpenALMusic

All Implemented Interfaces:

com.badlogic.gdx.audio.Music, com.badlogic.gdx.utils.Disposable

Direct Known Subclasses:

Mp3.Music, Ogg.Music, Wav.Music

public abstract class OpenALMusic
extends java.lang.Object
implements com.badlogic.gdx.audio.Music

Nested Class Summary

Nested classes/interfaces inherited from interface com.badlogic.gdx.audio.Music

com.badlogic.gdx.audio.Music.OnCompletionListener

Field Summary

Fields

Modifier and Type	Field	Description
protected com.badlogic.gdx.files.FileHandle	file

Constructor Summary

Constructors

Constructor	Description
OpenALMusic(OpenALLwjgl3Audio audio, com.badlogic.gdx.files.FileHandle file)

Method Summary

Modifier and Type	Method	Description
void	dispose()
int	getChannels()
float	getPosition()
int	getRate()
int	getSourceId()
float	getVolume()
boolean	isLooping()
boolean	isPlaying()
protected void	loop()	By default, does just the same as reset().
void	pause()
void	play()
abstract int	read(byte[] buffer)	Fills as much of the buffer as possible and returns the number of bytes filled.
abstract void	reset()	Resets the stream to the beginning.
void	setLooping(boolean isLooping)
void	setOnCompletionListener(com.badlogic.gdx.audio.Music.OnCompletionListener listener)
void	setPan(float pan, float volume)
void	setPosition(float position)
protected void	setup(int channels, int sampleRate)
void	setVolume(float volume)
void	stop()
void	update()

Methods inherited from class java.lang.Object

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

Field Detail

file

protected final com.badlogic.gdx.files.FileHandle file

Constructor Detail

OpenALMusic

public OpenALMusic(OpenALLwjgl3Audio audio,
                   com.badlogic.gdx.files.FileHandle file)

Method Detail

setup

protected void setup(int channels,
                     int sampleRate)

play

public void play()

Specified by:

play in interface com.badlogic.gdx.audio.Music

stop

public void stop()

Specified by:

stop in interface com.badlogic.gdx.audio.Music

pause

public void pause()

Specified by:

pause in interface com.badlogic.gdx.audio.Music

isPlaying

public boolean isPlaying()

Specified by:

isPlaying in interface com.badlogic.gdx.audio.Music

setLooping

public void setLooping(boolean isLooping)

Specified by:

setLooping in interface com.badlogic.gdx.audio.Music

isLooping

public boolean isLooping()

Specified by:

isLooping in interface com.badlogic.gdx.audio.Music

setVolume

public void setVolume(float volume)

Specified by:

setVolume in interface com.badlogic.gdx.audio.Music

Parameters:

volume - Must be > 0.

getVolume

public float getVolume()

Specified by:

getVolume in interface com.badlogic.gdx.audio.Music

setPan

public void setPan(float pan,
                   float volume)

Specified by:

setPan in interface com.badlogic.gdx.audio.Music

setPosition

public void setPosition(float position)

Specified by:

setPosition in interface com.badlogic.gdx.audio.Music

getPosition

public float getPosition()

Specified by:

getPosition in interface com.badlogic.gdx.audio.Music

read

public abstract int read(byte[] buffer)

Fills as much of the buffer as possible and returns the number of bytes filled. Returns <= 0 to indicate the end of the stream.

reset

public abstract void reset()

Resets the stream to the beginning.

loop

protected void loop()

By default, does just the same as reset(). Used to add special behaviour in Ogg.Music.

getChannels

public int getChannels()

getRate

public int getRate()

update

public void update()

dispose

public void dispose()

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable

Specified by:

dispose in interface com.badlogic.gdx.audio.Music

setOnCompletionListener

public void setOnCompletionListener(com.badlogic.gdx.audio.Music.OnCompletionListener listener)

Specified by:

setOnCompletionListener in interface com.badlogic.gdx.audio.Music

getSourceId

public int getSourceId()