com.badlogic.gdx.backends.lwjgl.audio

Class Mini2DxOpenALAudio

java.lang.Object

com.badlogic.gdx.backends.lwjgl.audio.Mini2DxOpenALAudio

All Implemented Interfaces:

com.badlogic.gdx.Audio, Mini2DxAudio

public class Mini2DxOpenALAudio
extends java.lang.Object
implements Mini2DxAudio

Modified version of OpenALAudio to support sound completion events

Constructor Summary

Constructors

Constructor and Description
Mini2DxOpenALAudio()
Mini2DxOpenALAudio(int simultaneousSources, int deviceBufferCount, int deviceBufferSize)

Method Summary

Modifier and Type	Method and Description
void	addSoundCompletionListener(SoundCompletionListener listener) Adds a SoundCompletionListener to listen for sound effect completion events
void	appendRecentSoundId(long soundId)
void	dispose() Disposes of allocated audio resources
void	forget(Mini2DxOpenALSound sound) Removes the disposed sound from the least recently played list
long	getSoundId(int sourceId)
boolean	isSoundPlaying(long soundId)
com.badlogic.gdx.audio.AudioDevice	newAudioDevice(int sampleRate, boolean isMono)
com.badlogic.gdx.audio.AudioRecorder	newAudioRecorder(int samplingRate, boolean isMono)
Mini2DxOpenALMusic	newMusic(com.badlogic.gdx.files.FileHandle file)
Mini2DxOpenALSound	newSound(com.badlogic.gdx.files.FileHandle file)
void	pauseSound(long soundId)
void	registerMusic(java.lang.String extension, java.lang.Class<? extends Mini2DxOpenALMusic> musicClass)
void	registerSound(java.lang.String extension, java.lang.Class<? extends Mini2DxOpenALSound> soundClass)
void	removeSoundCompletionListener(SoundCompletionListener listener) Removes a SoundCompletionListener
void	resumeSound(long soundId)
protected void	retain(Mini2DxOpenALSound sound, boolean stop) Retains a list of the most recently played sounds and stops the sound played least recently if necessary for a new sound to play
void	setSoundGain(long soundId, float volume)
void	setSoundLooping(long soundId, boolean looping)
void	setSoundPan(long soundId, float pan, float volume)
void	setSoundPitch(long soundId, float pitch)
void	stopSound(long soundId)
void	update() Updates the audio device and events

Methods inherited from class java.lang.Object

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

Constructor Detail

Mini2DxOpenALAudio

public Mini2DxOpenALAudio()

Mini2DxOpenALAudio

public Mini2DxOpenALAudio(int simultaneousSources,
                          int deviceBufferCount,
                          int deviceBufferSize)

Method Detail

addSoundCompletionListener

public void addSoundCompletionListener(SoundCompletionListener listener)

Description copied from interface: Mini2DxAudio

Adds a SoundCompletionListener to listen for sound effect completion events

Specified by:

addSoundCompletionListener in interface Mini2DxAudio

Parameters:

listener - The SoundCompletionListener implementation to add

removeSoundCompletionListener

public void removeSoundCompletionListener(SoundCompletionListener listener)

Description copied from interface: Mini2DxAudio

Removes a SoundCompletionListener

Specified by:

removeSoundCompletionListener in interface Mini2DxAudio

Parameters:

listener - The SoundCompletionListener implementation to remove

registerSound

public void registerSound(java.lang.String extension,
                          java.lang.Class<? extends Mini2DxOpenALSound> soundClass)

registerMusic

public void registerMusic(java.lang.String extension,
                          java.lang.Class<? extends Mini2DxOpenALMusic> musicClass)

newSound

public Mini2DxOpenALSound newSound(com.badlogic.gdx.files.FileHandle file)

Specified by:

newSound in interface com.badlogic.gdx.Audio

newMusic

public Mini2DxOpenALMusic newMusic(com.badlogic.gdx.files.FileHandle file)

Specified by:

newMusic in interface com.badlogic.gdx.Audio

update

public void update()

Description copied from interface: Mini2DxAudio

Updates the audio device and events

Specified by:

update in interface Mini2DxAudio

appendRecentSoundId

public void appendRecentSoundId(long soundId)

isSoundPlaying

public boolean isSoundPlaying(long soundId)

getSoundId

public long getSoundId(int sourceId)

stopSound

public void stopSound(long soundId)

pauseSound

public void pauseSound(long soundId)

resumeSound

public void resumeSound(long soundId)

setSoundGain

public void setSoundGain(long soundId,
                         float volume)

setSoundLooping

public void setSoundLooping(long soundId,
                            boolean looping)

setSoundPitch

public void setSoundPitch(long soundId,
                          float pitch)

setSoundPan

public void setSoundPan(long soundId,
                        float pan,
                        float volume)

dispose

public void dispose()

Description copied from interface: Mini2DxAudio

Disposes of allocated audio resources

Specified by:

dispose in interface Mini2DxAudio

newAudioDevice

public com.badlogic.gdx.audio.AudioDevice newAudioDevice(int sampleRate,
                                                         boolean isMono)

Specified by:

newAudioDevice in interface com.badlogic.gdx.Audio

newAudioRecorder

public com.badlogic.gdx.audio.AudioRecorder newAudioRecorder(int samplingRate,
                                                             boolean isMono)

Specified by:

newAudioRecorder in interface com.badlogic.gdx.Audio

retain

protected void retain(Mini2DxOpenALSound sound,
                      boolean stop)

Retains a list of the most recently played sounds and stops the sound played least recently if necessary for a new sound to play

forget

public void forget(Mini2DxOpenALSound sound)

Removes the disposed sound from the least recently played list