org.mini2Dx.core

Interface Audio

public interface Audio

Provides audio functionality

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 newSound(FileHandle).
Music	newMusic(byte[] bytes, java.lang.String format) Creates a new Music instance used to play back an audio stream.
default Music	newMusic(FileHandle fileHandle) Creates a new Music instance used to play back an audio stream from a file.
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	removeMusicCompletionListener(MusicCompletionListener completionListener) Removes a MusicCompletionListener
void	removeSoundCompletionListener(SoundCompletionListener completionListener) Removes a SoundCompletionListener

Method Detail

newSound

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

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

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

AsyncSoundResult newAsyncSound(FileHandle fileHandle)

See 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.

Parameters:

fileHandle - The FileHandle to load the audio from

Returns:

The AsyncSoundResult instance that's loading the sound

newMusic

default Music newMusic(FileHandle fileHandle)
                throws java.io.IOException

Creates a new Music instance used to play back an audio stream from a file. 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

Parameters:

fileHandle - The FileHandle to stream the audio from

Returns:

The new Music instance

Throws:

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

newMusic

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

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

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

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

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

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

void addMusicCompletionListener(MusicCompletionListener completionListener)

Adds a MusicCompletionListener

Parameters:

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

removeMusicCompletionListener

void removeMusicCompletionListener(MusicCompletionListener completionListener)

Removes a MusicCompletionListener

Parameters:

completionListener - The MusicCompletionListener to be removed

addSoundCompletionListener

void addSoundCompletionListener(SoundCompletionListener completionListener)

Adds a SoundCompletionListener

Parameters:

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

removeSoundCompletionListener

void removeSoundCompletionListener(SoundCompletionListener completionListener)

Removes a SoundCompletionListener

Parameters:

completionListener - The SoundCompletionListener to be removed