org.mini2Dx.libgdx

Class LibgdxAudio

java.lang.Object

org.mini2Dx.libgdx.LibgdxAudio

All Implemented Interfaces:

Audio

public class LibgdxAudio
extends java.lang.Object
implements Audio

Constructor Summary

Constructors

Constructor and Description
LibgdxAudio()

Method Summary

Modifier and Type	Method and Description
void	addMusicCompletionListener(MusicCompletionListener completionListener) Adds a MusicCompletionListener
void	addSoundCompletionListener(SoundCompletionListener completionListener) Adds a SoundCompletionListener
AsyncSoundResult	newAsyncSound(FileHandle fileHandle) See Audio.newSound(FileHandle).
Music	newMusic(byte[] bytes, java.lang.String format) Creates a new Music instance used to play back an audio stream.
Music	newMusic(FileHandle fileHandle, boolean loadIntoMemory) Creates a new Music instance used to play back an audio stream.
Sound	newSound(FileHandle fileHandle) Creates a new Sound instance used to play back audio sound effects (e.g.
void	notifyMusicCompletionListeners(Music music)
void	notifySoundCompletionListeners(long soundId)
void	removeMusicCompletionListener(MusicCompletionListener completionListener) Removes a MusicCompletionListener
void	removeSoundCompletionListener(SoundCompletionListener completionListener) Removes a SoundCompletionListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.core.Audio

newMusic

Constructor Detail

LibgdxAudio

public LibgdxAudio()

Method Detail

newSound

public Sound newSound(FileHandle fileHandle)
               throws java.io.IOException

Description copied from interface: Audio

Creates a new Sound instance used to play back audio sound effects (e.g. explosions, gunshots, etc.). Note that the complete audio data is loaded into RAM and you should avoid loading large files. The current upper limit for decoded audio is 1 MB.

Currently supported formats are WAV, MP3 and OGG.

When the Sound instance is no longer needed, call the Disposable.dispose() method

Specified by:

newSound in interface Audio

Parameters:

fileHandle - The FileHandle to load the audio from

Returns:

The new Sound instance

Throws:

java.io.IOException - Thrown when the sound could not be loaded

newAsyncSound

public AsyncSoundResult newAsyncSound(FileHandle fileHandle)

Description copied from interface: Audio

See Audio.newSound(FileHandle). Loads a new Sound instance asynchronously. On platforms not supporting async sound loading a warning will be logged and the sound would be loaded on game thread when AsyncSoundResult.getResult() is called. Supported platforms: Libgdx Desktop LWJGL2/3, Monogame.

Specified by:

newAsyncSound in interface Audio

Parameters:

fileHandle - The FileHandle to load the audio from

Returns:

The AsyncSoundResult instance that's loading the sound

newMusic

public Music newMusic(FileHandle fileHandle,
                      boolean loadIntoMemory)
               throws java.io.IOException

Description copied from interface: Audio

Creates a new Music instance used to play back an audio stream. Music instances are automatically paused when the application is paused and resumed when the application is resumed.

Currently supported formats are WAV, MP3 and OGG.

When the Music instance is no longer needed, call the Disposable.dispose() method

Specified by:

newMusic in interface Audio

Parameters:

fileHandle - The FileHandle to stream the audio from

loadIntoMemory - True if the file should be read into memory and streamed from memory. False, if streamed for disk.

Returns:

The new Music instance

Throws:

java.io.IOException - Thrown when the music could not be loaded

newMusic

public Music newMusic(byte[] bytes,
                      java.lang.String format)
               throws java.io.IOException

Description copied from interface: Audio

Creates a new Music instance used to play back an audio stream. Music instances are automatically paused when the application is paused and resumed when the application is resumed.

Currently supported formats are WAV, MP3 and OGG.

When the Music instance is no longer needed, call the Disposable.dispose() method

Specified by:

newMusic in interface Audio

Parameters:

bytes - The byte array to stream the audio from

format - "ogg", "mp3" or "wav"

Returns:

The new Music instance

Throws:

java.io.IOException - Thrown when the music could not be loaded

addMusicCompletionListener

public void addMusicCompletionListener(MusicCompletionListener completionListener)

Description copied from interface: Audio

Adds a MusicCompletionListener

Specified by:

addMusicCompletionListener in interface Audio

Parameters:

completionListener - The MusicCompletionListener to be notified of Music completion events.

removeMusicCompletionListener

public void removeMusicCompletionListener(MusicCompletionListener completionListener)

Description copied from interface: Audio

Removes a MusicCompletionListener

Specified by:

removeMusicCompletionListener in interface Audio

Parameters:

completionListener - The MusicCompletionListener to be removed

addSoundCompletionListener

public void addSoundCompletionListener(SoundCompletionListener completionListener)

Description copied from interface: Audio

Adds a SoundCompletionListener

Specified by:

addSoundCompletionListener in interface Audio

Parameters:

completionListener - The SoundCompletionListener to be notified of Sound completion events.

removeSoundCompletionListener

public void removeSoundCompletionListener(SoundCompletionListener completionListener)

Description copied from interface: Audio

Removes a SoundCompletionListener

Specified by:

removeSoundCompletionListener in interface Audio

Parameters:

completionListener - The SoundCompletionListener to be removed

notifyMusicCompletionListeners

public void notifyMusicCompletionListeners(Music music)

notifySoundCompletionListeners

public void notifySoundCompletionListeners(long soundId)