org.mini2Dx.core.audio

Class AsyncSoundResult

java.lang.Object

org.mini2Dx.core.audio.AsyncSoundResult

All Implemented Interfaces:

AsyncFuture, AsyncResult<Sound>

Direct Known Subclasses:

LibgdxAsyncSoundResult

public abstract class AsyncSoundResult
extends java.lang.Object
implements AsyncResult<Sound>

Field Summary

Fields

Modifier and Type	Field and Description
protected FileHandle	handle

Constructor Summary

Constructors

Constructor and Description
AsyncSoundResult(FileHandle file)

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.concurrent.Callable<java.lang.Object>	asyncReadFile(FileHandle file) Returns a Callable which does the I/O required to load the sound.
Sound	getResult() Returns the Sound object.
boolean	isFinished() Returns if the sound has been loaded.
protected abstract Sound	makeSound(AsyncResult<java.lang.Object> result) Instantiates a Sound object on the current thread.

Methods inherited from class java.lang.Object

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

Field Detail

handle

protected final FileHandle handle

Constructor Detail

AsyncSoundResult

public AsyncSoundResult(FileHandle file)

Method Detail

isFinished

public boolean isFinished()

Returns if the sound has been loaded.

Specified by:

isFinished in interface AsyncFuture

Returns:

False if the sound is still loading

getResult

public Sound getResult()

Returns the Sound object. If the platform doesn't support async sound loading (see Audio.newAsyncSound(FileHandle)) the sound object is cached for future access.

Specified by:

getResult in interface AsyncResult<Sound>

Returns:

the Sound object

asyncReadFile

protected abstract java.util.concurrent.Callable<java.lang.Object> asyncReadFile(FileHandle file)

Returns a Callable which does the I/O required to load the sound.

Parameters:

file - The FileHandle to load the audio from

Returns:

a Callable doing the required I/O.

makeSound

protected abstract Sound makeSound(AsyncResult<java.lang.Object> result)

Instantiates a Sound object on the current thread.

Parameters:

result - an AsyncResult containing the results of {asyncReadFile(FileHandle)}

Returns:

the new Sound object