com.badlogic.gdx.assets.loaders

Class MusicLoader

java.lang.Object

com.badlogic.gdx.assets.loaders.AssetLoader<T,P>

com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader<Music,MusicLoader.MusicParameter>

com.badlogic.gdx.assets.loaders.MusicLoader

public class MusicLoader
extends AsynchronousAssetLoader<Music,MusicLoader.MusicParameter>

AssetLoader for Music instances. The Music instance is loaded synchronously.

Author:

mzechner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MusicLoader.MusicParameter

Constructor Summary

Constructors

Constructor and Description
MusicLoader(FileHandleResolver resolver)

Method Summary

Modifier and Type	Method and Description
Array<AssetDescriptor>	getDependencies(java.lang.String fileName, FileHandle file, MusicLoader.MusicParameter parameter) Returns the assets this asset requires to be loaded first.
protected Music	getLoadedMusic() Returns the Music instance currently loaded by this MusicLoader.
void	loadAsync(AssetManager manager, java.lang.String fileName, FileHandle file, MusicLoader.MusicParameter parameter) Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.
Music	loadSync(AssetManager manager, java.lang.String fileName, FileHandle file, MusicLoader.MusicParameter parameter) Loads the OpenGL part of the asset.

Methods inherited from class com.badlogic.gdx.assets.loaders.AssetLoader

resolve

Methods inherited from class java.lang.Object

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

Constructor Detail

MusicLoader

public MusicLoader(FileHandleResolver resolver)

Method Detail

getLoadedMusic

protected Music getLoadedMusic()

Returns the Music instance currently loaded by this MusicLoader.

Returns:

the currently loaded Music, otherwise null if no Music has been loaded yet.

loadAsync

public void loadAsync(AssetManager manager,
                      java.lang.String fileName,
                      FileHandle file,
                      MusicLoader.MusicParameter parameter)

Description copied from class: AsynchronousAssetLoader

Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.

Specified by:

loadAsync in class AsynchronousAssetLoader<Music,MusicLoader.MusicParameter>

fileName - the name of the asset to load

file - the resolved file to load

parameter - the parameters to use for loading the asset

loadSync

public Music loadSync(AssetManager manager,
                      java.lang.String fileName,
                      FileHandle file,
                      MusicLoader.MusicParameter parameter)

Description copied from class: AsynchronousAssetLoader

Loads the OpenGL part of the asset.

Specified by:

loadSync in class AsynchronousAssetLoader<Music,MusicLoader.MusicParameter>

file - the resolved file to load

getDependencies

public Array<AssetDescriptor> getDependencies(java.lang.String fileName,
                                              FileHandle file,
                                              MusicLoader.MusicParameter parameter)

Description copied from class: AssetLoader

Returns the assets this asset requires to be loaded first. This method may be called on a thread other than the GL thread.

Specified by:

getDependencies in class AssetLoader<Music,MusicLoader.MusicParameter>

Parameters:

fileName - name of the asset to load

file - the resolved file to load

parameter - parameters for loading the asset

Returns:

other assets that the asset depends on and need to be loaded first or null if there are no dependencies.