Package net.minecraft.client.sounds

Class SoundBufferLibrary

java.lang.Object

net.minecraft.client.sounds.SoundBufferLibrary

public class SoundBufferLibrary
extends Object

The SoundBufferLibrary class provides a cache containing instances of SoundBuffer and AudioStream for use in Minecraft sound handling.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<ResourceLocation,CompletableFuture<SoundBuffer>>	cache
private final ResourceProvider	resourceManager	The ResourceProvider used for loading sound resources.

Constructor Summary

Constructors

Constructor	Description
SoundBufferLibrary(ResourceProvider pResourceManager)

Method Summary

Modifier and Type	Method	Description
void	clear()
CompletableFuture<SoundBuffer>	getCompleteBuffer(ResourceLocation pSoundID)	Returns Returns a CompletableFuture containing the complete SoundBuffer. The SoundBuffer is loaded asynchronously and cached..
CompletableFuture<AudioStream>	getStream(ResourceLocation pResourceLocation, boolean pIsWrapper)	Returns Returns a CompletableFuture containing the AudioStream. The AudioStream is loaded asynchronously..
CompletableFuture<?>	preload(Collection<Sound> pSounds)	Preloads the SoundBuffer objects for the specified collection of sounds.

Methods inherited from class java.lang.Object

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

Field Details

resourceManager

private final ResourceProvider resourceManager

The ResourceProvider used for loading sound resources.

cache

private final Map<ResourceLocation,CompletableFuture<SoundBuffer>> cache

Constructor Details

SoundBufferLibrary

public SoundBufferLibrary(ResourceProvider pResourceManager)

Method Details

getCompleteBuffer

public CompletableFuture<SoundBuffer> getCompleteBuffer(ResourceLocation pSoundID)

Returns Returns a CompletableFuture containing the complete SoundBuffer. The SoundBuffer is loaded asynchronously and cached..

Parameters:

pSoundID - the ResourceLocation of the sound

Returns:

Returns a CompletableFuture containing the complete SoundBuffer. The SoundBuffer is loaded asynchronously and cached.

getStream

public CompletableFuture<AudioStream> getStream(ResourceLocation pResourceLocation,
 boolean pIsWrapper)

Returns Returns a CompletableFuture containing the AudioStream. The AudioStream is loaded asynchronously..

Parameters:

pResourceLocation - the ResourceLocation of the sound

pIsWrapper - whether the AudioStream should be a invalid input: '{@' linkplain LoopingAudioStream}

Returns:

Returns a CompletableFuture containing the AudioStream. The AudioStream is loaded asynchronously.

clear

public void clear()

preload

public CompletableFuture<?> preload(Collection<Sound> pSounds)

Preloads the SoundBuffer objects for the specified collection of sounds.

Parameters:

pSounds - the collection of sounds to preload

Returns:

a CompletableFuture representing the completion of the preload operation