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

Modifier and Type	Field and Description
private IntArray	allSources
pack-priv long	context
pack-priv long	device
private final int	deviceBufferCount
private final int	deviceBufferSize
private ObjectMap<String, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALMusic>>	extensionToMusicClass
private ObjectMap<String, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALSound>>	extensionToSoundClass
private IntArray	idleSources
private int	mostRecetSound
pack-priv Array<OpenALMusic>	music
private long	nextSoundId
pack-priv boolean	noDevice
private Thread	observerThread
private String	preferredOutputDevice
private OpenALSound[]	recentSounds
private LongMap<Integer>	soundIdToSource
private IntMap<Long>	sourceToSoundId

Access	Constructor and Description
public	OpenALLwjgl3Audio()
public	OpenALLwjgl3Audio(int simultaneousSources, int deviceBufferCount, int deviceBufferSize)

Method Summary

Modifier and Type	Method and Description
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object.
public void	forget(OpenALSound sound) Removes the disposed sound from the least recently played list
pack-priv void	freeBuffer(int bufferID)
pack-priv void	freeSource(int sourceID)
public String[]	getAvailableOutputDevices() Implements com.badlogic.gdx.Audio.getAvailableOutputDevices. This function returns a list of fully qualified Output device names.
public long	getSoundId(int sourceId)
public int	getSourceId(long soundId)
public AudioDevice	newAudioDevice(int sampleRate, final boolean isMono) Implements com.badlogic.gdx.Audio.newAudioDevice. Creates a new `AudioDevice` either in mono or stereo mode.
public AudioRecorder	newAudioRecorder(int samplingRate, boolean isMono) Implements com.badlogic.gdx.Audio.newAudioRecorder. Creates a new `AudioRecorder`.
public OpenALMusic	newMusic(FileHandle file) Implements com.badlogic.gdx.Audio.newMusic. Creates a new `Music` instance which is used to play back a music stream from a file.
public OpenALSound	newSound(FileHandle file) Implements com.badlogic.gdx.Audio.newSound. Creates a new `Sound` which is used to play back audio effects such as gun shots or explosions.
public OpenALSound	newSound(FileHandle file, String extension)
pack-priv int	obtainSource(boolean isMusic)
public void	pauseSound(long soundId)
pack-priv void	pauseSourcesWithBuffer(int bufferID)
public void	registerMusic(String extension, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALMusic> soundSupplier)
public void	registerSound(String extension, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALSound> soundSupplier)
public void	resumeSound(long soundId)
pack-priv void	resumeSourcesWithBuffer(int bufferID)
protected void	retain(OpenALSound 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
public void	setSoundGain(long soundId, float volume)
public void	setSoundLooping(long soundId, boolean looping)
public void	setSoundPan(long soundId, float pan, float volume)
public void	setSoundPitch(long soundId, float pitch)
public void	stopSound(long soundId)
pack-priv void	stopSourcesWithBuffer(int bufferID)
public boolean	switchOutputDevice(String deviceIdentifier) Implements com.badlogic.gdx.Audio.switchOutputDevice. Sets a new OutputDevice.
private boolean	switchOutputDevice(String deviceIdentifier, boolean setPreferred)
public void	update() Implements com.badlogic.gdx.backends.lwjgl3.audio.Lwjgl3Audio.update.

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

allSources	back to summary
private IntArray allSources

context	back to summary
pack-priv long context

device	back to summary
pack-priv long device

deviceBufferCount	back to summary
private final int deviceBufferCount

deviceBufferSize	back to summary
private final int deviceBufferSize

extensionToMusicClass	back to summary
private ObjectMap<String, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALMusic>> extensionToMusicClass

extensionToSoundClass	back to summary
private ObjectMap<String, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALSound>> extensionToSoundClass

idleSources	back to summary
private IntArray idleSources

mostRecetSound	back to summary
private int mostRecetSound

music	back to summary
pack-priv Array<OpenALMusic> music

nextSoundId	back to summary
private long nextSoundId

noDevice	back to summary
pack-priv boolean noDevice

observerThread	back to summary
private Thread observerThread

preferredOutputDevice	back to summary
private String preferredOutputDevice

recentSounds	back to summary
private OpenALSound[] recentSounds

soundIdToSource	back to summary
private LongMap<Integer> soundIdToSource

sourceToSoundId	back to summary
private IntMap<Long> sourceToSoundId

OpenALLwjgl3Audio	back to summary
public OpenALLwjgl3Audio()

OpenALLwjgl3Audio	back to summary
public OpenALLwjgl3Audio(int simultaneousSources, int deviceBufferCount, int deviceBufferSize)

Method Detail

dispose	back to summary
public void dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Doc from com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object. Annotations @Override

dispose

back to summary

public void dispose()

Implements com.badlogic.gdx.utils.Disposable.dispose.

Doc from com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

Annotations

@Override

forget	back to summary
public void forget(OpenALSound sound) Removes the disposed sound from the least recently played list

freeBuffer	back to summary
pack-priv void freeBuffer(int bufferID)

freeSource	back to summary
pack-priv void freeSource(int sourceID)

getAvailableOutputDevices	back to summary
public String[] getAvailableOutputDevices() Implements com.badlogic.gdx.Audio.getAvailableOutputDevices. Doc from com.badlogic.gdx.Audio.getAvailableOutputDevices. This function returns a list of fully qualified Output device names. This function is only implemented on desktop and web. Note that on gwt the GwtApplicationConfiguration#fetchAvailableOutputDevices attribute needs to be set to true for asking the user for permission! On all other platforms it will return an empty array. It will also return an empty array on error. The names returned need os dependent preprocessing before exposing to a user. Annotations @Override

getAvailableOutputDevices

back to summary

public String[] getAvailableOutputDevices()

Implements com.badlogic.gdx.Audio.getAvailableOutputDevices.

Doc from com.badlogic.gdx.Audio.getAvailableOutputDevices.

This function returns a list of fully qualified Output device names. This function is only implemented on desktop and web. Note that on gwt the GwtApplicationConfiguration#fetchAvailableOutputDevices attribute needs to be set to true for asking the user for permission! On all other platforms it will return an empty array. It will also return an empty array on error. The names returned need os dependent preprocessing before exposing to a user.

Annotations

@Override

getSoundId	back to summary
public long getSoundId(int sourceId)

getSourceId	back to summary
public int getSourceId(long soundId)

newAudioDevice back to summary

newAudioDevice	back to summary
public AudioDevice newAudioDevice(int sampleRate, final boolean isMono) Implements com.badlogic.gdx.Audio.newAudioDevice. Doc from com.badlogic.gdx.Audio.newAudioDevice. Creates a new `AudioDevice` either in mono or stereo mode. The AudioDevice has to be disposed via its `AudioDevice#dispose()` method when it is no longer used.

public AudioDevice newAudioDevice(int sampleRate, final boolean isMono)

Implements com.badlogic.gdx.Audio.newAudioDevice.

Doc from com.badlogic.gdx.Audio.newAudioDevice.

Creates a new AudioDevice either in mono or stereo mode. The AudioDevice has to be disposed via its AudioDevice#dispose() method when it is no longer used.

newAudioRecorder back to summary

newAudioRecorder	back to summary
public AudioRecorder newAudioRecorder(int samplingRate, boolean isMono) Implements com.badlogic.gdx.Audio.newAudioRecorder. Doc from com.badlogic.gdx.Audio.newAudioRecorder. Creates a new `AudioRecorder`. The AudioRecorder has to be disposed after it is no longer used.

public AudioRecorder newAudioRecorder(int samplingRate, boolean isMono)

Implements com.badlogic.gdx.Audio.newAudioRecorder.

Doc from com.badlogic.gdx.Audio.newAudioRecorder.

Creates a new AudioRecorder. The AudioRecorder has to be disposed after it is no longer used.

newMusic back to summary

newMusic	back to summary
public OpenALMusic newMusic(FileHandle file) Implements com.badlogic.gdx.Audio.newMusic. Doc from com.badlogic.gdx.Audio.newMusic. Creates a new `Music` instance which is used to play back a music stream from a file. Currently supported formats are WAV, MP3 and OGG. The Music instance has to be disposed if it is no longer used via the `Music#dispose()` method. Music instances are automatically paused when `ApplicationListener#pause()` is called and resumed when `ApplicationListener#resume()` is called.

public OpenALMusic newMusic(FileHandle file)

Implements com.badlogic.gdx.Audio.newMusic.

Doc from com.badlogic.gdx.Audio.newMusic.

Creates a new Music instance which is used to play back a music stream from a file. Currently supported formats are WAV, MP3 and OGG. The Music instance has to be disposed if it is no longer used via the Music#dispose() method. Music instances are automatically paused when ApplicationListener#pause() is called and resumed when ApplicationListener#resume() is called.

newSound back to summary

newSound	back to summary
public OpenALSound newSound(FileHandle file) Implements com.badlogic.gdx.Audio.newSound. Doc from com.badlogic.gdx.Audio.newSound. Creates a new `Sound` which is used to play back audio effects such as gun shots or explosions. The Sound's audio data is retrieved from the file specified via the `FileHandle`. Note that the complete audio data is loaded into RAM. You should therefore not load big audio files with this methods. The current upper limit for decoded audio is 1 MB. Currently supported formats are WAV, MP3 and OGG. The Sound has to be disposed if it is no longer used via the `Sound#dispose()` method.

public OpenALSound newSound(FileHandle file)

Implements com.badlogic.gdx.Audio.newSound.

Doc from com.badlogic.gdx.Audio.newSound.

Creates a new Sound which is used to play back audio effects such as gun shots or explosions. The Sound's audio data is retrieved from the file specified via the FileHandle. Note that the complete audio data is loaded into RAM. You should therefore not load big audio files with this methods. The current upper limit for decoded audio is 1 MB.

Currently supported formats are WAV, MP3 and OGG.

The Sound has to be disposed if it is no longer used via the Sound#dispose() method.

newSound	back to summary
public OpenALSound newSound(FileHandle file, String extension)

obtainSource	back to summary
pack-priv int obtainSource(boolean isMusic)

pauseSound	back to summary
public void pauseSound(long soundId)

pauseSourcesWithBuffer	back to summary
pack-priv void pauseSourcesWithBuffer(int bufferID)

registerMusic	back to summary
public void registerMusic(String extension, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALMusic> soundSupplier)

registerSound	back to summary
public void registerSound(String extension, BiFunction<OpenALLwjgl3Audio, FileHandle, OpenALSound> soundSupplier)

resumeSound	back to summary
public void resumeSound(long soundId)

resumeSourcesWithBuffer	back to summary
pack-priv void resumeSourcesWithBuffer(int bufferID)

retain	back to summary
protected void retain(OpenALSound 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

setSoundGain	back to summary
public void setSoundGain(long soundId, float volume)

setSoundLooping	back to summary
public void setSoundLooping(long soundId, boolean looping)

setSoundPan	back to summary
public void setSoundPan(long soundId, float pan, float volume)

setSoundPitch	back to summary
public void setSoundPitch(long soundId, float pitch)

stopSound	back to summary
public void stopSound(long soundId)

stopSourcesWithBuffer	back to summary
pack-priv void stopSourcesWithBuffer(int bufferID)

switchOutputDevice back to summary

switchOutputDevice	back to summary
public boolean switchOutputDevice(String deviceIdentifier) Implements com.badlogic.gdx.Audio.switchOutputDevice. Doc from com.badlogic.gdx.Audio.switchOutputDevice. Sets a new OutputDevice. The identifier can be retrieved from `Audio#getAvailableOutputDevices()`. If null is passed, it will switch to auto. Annotations @Override

public boolean switchOutputDevice(String deviceIdentifier)

Implements com.badlogic.gdx.Audio.switchOutputDevice.

Doc from com.badlogic.gdx.Audio.switchOutputDevice.

Sets a new OutputDevice. The identifier can be retrieved from Audio#getAvailableOutputDevices(). If null is passed, it will switch to auto.

Annotations