libGDX 1.14.2 · com.badlogic.gdx.backends.lwjgl3.audio.OpenALMusic

Field Summary

Modifier and Type	Field and Description
private final OpenALLwjgl3Audio	audio
private static final int	bufferCount
private IntBuffer	buffers
private static final int	bufferSize
protected final FileHandle	file
private int	format
private boolean	isLooping
private boolean	isPlaying
private float	maxSecondsPerBuffer
private Music.OnCompletionListener	onCompletionListener
private float	pan
private float	renderedSeconds
private FloatArray	renderedSecondsQueue
private int	sampleRate
private int	sourceID
private static final ByteBuffer	tempBuffer
private static final byte[]	tempBytes
private float	volume

Constructor Summary

Access	Constructor and Description
public	OpenALMusic(OpenALLwjgl3Audio audio, FileHandle file)

Method Summary

Modifier and Type	Method and Description
public void	dispose() Implements com.badlogic.gdx.audio.Music.dispose. Needs to be called when the Music is no longer needed.
private boolean	fill(int bufferID)
public int	getChannels()
public float	getPosition() Implements com.badlogic.gdx.audio.Music.getPosition. Returns the playback position in seconds.
public int	getRate()
public int	getSourceId()
public float	getVolume() Implements com.badlogic.gdx.audio.Music.getVolume.
public boolean	isLooping() Implements com.badlogic.gdx.audio.Music.isLooping.
public boolean	isPlaying() Implements com.badlogic.gdx.audio.Music.isPlaying.
protected void	loop() By default, does just the same as reset().
public void	pause() Implements com.badlogic.gdx.audio.Music.pause. Pauses the play back.
public void	play() Implements com.badlogic.gdx.audio.Music.play. Starts the play back of the music stream.
public abstract int	read(byte[] buffer) Fills as much of the buffer as possible and returns the number of bytes filled.
public abstract void	reset() Resets the stream to the beginning.
public void	setLooping(boolean isLooping) Implements com.badlogic.gdx.audio.Music.setLooping. Sets whether the music stream is looping.
public void	setOnCompletionListener(Music.OnCompletionListener listener) Implements com.badlogic.gdx.audio.Music.setOnCompletionListener. Register a callback to be invoked when the end of a music stream has been reached during playback.
public void	setPan(float pan, float volume) Implements com.badlogic.gdx.audio.Music.setPan. Sets the panning and volume of this music stream.
public void	setPosition(float position) Implements com.badlogic.gdx.audio.Music.setPosition. Set the playback position in seconds.
protected void	setup(int The number of channels for the music. Most commonly 1 (for mono) or 2 (for stereo). channels, int The number of bits in each sample. Normally 16. Can also be 8, 32, 64. bitDepth, int The number of samples to be played each second. Commonly 44100; can be anything within reason. sampleRate) Prepare our music for playback!
public void	setVolume(float Must be > 0. volume) Implements com.badlogic.gdx.audio.Music.setVolume. Sets the volume of this music stream.
public void	stop() Implements com.badlogic.gdx.audio.Music.stop. Stops a playing or paused Music instance.
public void	update()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

audio	back to summary
private final OpenALLwjgl3Audio audio

bufferCount	back to summary
private static final int bufferCount

buffers	back to summary
private IntBuffer buffers

bufferSize	back to summary
private static final int bufferSize

file	back to summary
protected final FileHandle file

format	back to summary
private int format

isLooping	back to summary
private boolean isLooping

isPlaying	back to summary
private boolean isPlaying

maxSecondsPerBuffer	back to summary
private float maxSecondsPerBuffer

onCompletionListener	back to summary
private Music.OnCompletionListener onCompletionListener

pan	back to summary
private float pan

renderedSeconds	back to summary
private float renderedSeconds

renderedSecondsQueue	back to summary
private FloatArray renderedSecondsQueue

sampleRate	back to summary
private int sampleRate

sourceID	back to summary
private int sourceID

tempBuffer	back to summary
private static final ByteBuffer tempBuffer

tempBytes	back to summary
private static final byte[] tempBytes

volume	back to summary
private float volume

Constructor Detail

OpenALMusic	back to summary
public OpenALMusic(OpenALLwjgl3Audio audio, FileHandle file)

Method Detail

dispose	back to summary
public void dispose() Implements com.badlogic.gdx.audio.Music.dispose. Doc from com.badlogic.gdx.audio.Music.dispose. Needs to be called when the Music is no longer needed.

dispose

back to summary

public void dispose()

Implements com.badlogic.gdx.audio.Music.dispose.

Doc from com.badlogic.gdx.audio.Music.dispose.

Needs to be called when the Music is no longer needed.

fill	back to summary
private boolean fill(int bufferID)

getChannels	back to summary
public int getChannels()

getPosition	back to summary
public float getPosition() Implements com.badlogic.gdx.audio.Music.getPosition. Doc from com.badlogic.gdx.audio.Music.getPosition. Returns the playback position in seconds.

getPosition

back to summary

public float getPosition()

Implements com.badlogic.gdx.audio.Music.getPosition.

Doc from com.badlogic.gdx.audio.Music.getPosition.

Returns the playback position in seconds.

getRate	back to summary
public int getRate()

getSourceId	back to summary
public int getSourceId()

getVolume	back to summary
public float getVolume() Implements com.badlogic.gdx.audio.Music.getVolume.

isLooping	back to summary
public boolean isLooping() Implements com.badlogic.gdx.audio.Music.isLooping.

isPlaying	back to summary
public boolean isPlaying() Implements com.badlogic.gdx.audio.Music.isPlaying.

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

pause	back to summary
public void pause() Implements com.badlogic.gdx.audio.Music.pause. Doc from com.badlogic.gdx.audio.Music.pause. Pauses the play back. If the music stream has not been started yet or has finished playing a call to this method will be ignored.

pause

back to summary

public void pause()

Implements com.badlogic.gdx.audio.Music.pause.

Doc from com.badlogic.gdx.audio.Music.pause.

Pauses the play back. If the music stream has not been started yet or has finished playing a call to this method will be ignored.

play	back to summary
public void play() Implements com.badlogic.gdx.audio.Music.play. Doc from com.badlogic.gdx.audio.Music.play. Starts the play back of the music stream. In case the stream was paused this will resume the play back. In case the music stream is finished playing this will restart the play back.

play

back to summary

public void play()

Implements com.badlogic.gdx.audio.Music.play.

Doc from com.badlogic.gdx.audio.Music.play.

Starts the play back of the music stream. In case the stream was paused this will resume the play back. In case the music stream is finished playing this will restart the play back.

read	back to summary
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	back to summary
public abstract void reset() Resets the stream to the beginning.

setLooping	back to summary
public void setLooping(boolean isLooping) Implements com.badlogic.gdx.audio.Music.setLooping. Doc from com.badlogic.gdx.audio.Music.setLooping. Sets whether the music stream is looping. This can be called at any time, whether the stream is playing.

setLooping

back to summary

public void setLooping(boolean isLooping)

Implements com.badlogic.gdx.audio.Music.setLooping.

Doc from com.badlogic.gdx.audio.Music.setLooping.

Sets whether the music stream is looping. This can be called at any time, whether the stream is playing.

setOnCompletionListener	back to summary
public void setOnCompletionListener(Music.OnCompletionListener listener) Implements com.badlogic.gdx.audio.Music.setOnCompletionListener. Doc from com.badlogic.gdx.audio.Music.setOnCompletionListener. Register a callback to be invoked when the end of a music stream has been reached during playback.

setOnCompletionListener

back to summary

public void setOnCompletionListener(Music.OnCompletionListener listener)

Implements com.badlogic.gdx.audio.Music.setOnCompletionListener.

Doc from com.badlogic.gdx.audio.Music.setOnCompletionListener.

setPan	back to summary
public void setPan(float pan, float volume) Implements com.badlogic.gdx.audio.Music.setPan. Doc from com.badlogic.gdx.audio.Music.setPan. Sets the panning and volume of this music stream.

setPan

back to summary

public void setPan(float pan, float volume)

Implements com.badlogic.gdx.audio.Music.setPan.

Doc from com.badlogic.gdx.audio.Music.setPan.

Sets the panning and volume of this music stream.

setPosition	back to summary
public void setPosition(float position) Implements com.badlogic.gdx.audio.Music.setPosition. Doc from com.badlogic.gdx.audio.Music.setPosition. Set the playback position in seconds.

setPosition

back to summary

public void setPosition(float position)

Implements com.badlogic.gdx.audio.Music.setPosition.

Doc from com.badlogic.gdx.audio.Music.setPosition.

Set the playback position in seconds.

setup	back to summary
protected void setup(int channels, int bitDepth, int sampleRate) Prepare our music for playback! Parameters channels:int The number of channels for the music. Most commonly 1 (for mono) or 2 (for stereo). bitDepth:int The number of bits in each sample. Normally 16. Can also be 8, 32, 64. sampleRate:int The number of samples to be played each second. Commonly 44100; can be anything within reason.

setup

back to summary

protected void setup(int channels, int bitDepth, int sampleRate)

Prepare our music for playback!

Parameters

channels:int: The number of channels for the music. Most commonly 1 (for mono) or 2 (for stereo).
bitDepth:int: The number of bits in each sample. Normally 16. Can also be 8, 32, 64.
sampleRate:int: The number of samples to be played each second. Commonly 44100; can be anything within reason.

setVolume	back to summary
public void setVolume(float volume) Implements com.badlogic.gdx.audio.Music.setVolume. Doc from com.badlogic.gdx.audio.Music.setVolume. Sets the volume of this music stream. The volume must be given in the range [0,1] with 0 being silent and 1 being the maximum volume. Parameters volume:float Must be > 0.

setVolume

back to summary

public void setVolume(float volume)

Implements com.badlogic.gdx.audio.Music.setVolume.

Doc from com.badlogic.gdx.audio.Music.setVolume.

Sets the volume of this music stream. The volume must be given in the range [0,1] with 0 being silent and 1 being the maximum volume.

Parameters

volume:float: Must be > 0.

stop	back to summary
public void stop() Implements com.badlogic.gdx.audio.Music.stop. Doc from com.badlogic.gdx.audio.Music.stop. Stops a playing or paused Music instance. Next time play() is invoked the Music will start from the beginning.

stop

back to summary

public void stop()

Implements com.badlogic.gdx.audio.Music.stop.

Doc from com.badlogic.gdx.audio.Music.stop.

Stops a playing or paused Music instance. Next time play() is invoked the Music will start from the beginning.

update	back to summary
public void update()

public abstract Class OpenALMusic

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail