SoundEffectPool
public final class SoundEffectPool implements AutoCloseable
Manages the loading and unloading of sound assets into memory.
If the value of the maxStreams parameter exceeds the capabilities for the platform then the value will be clamped to the platform's max number of supported streams.
Summary
Nested types |
|---|
public fun interface SoundEffectPool.LoadCompleteListenerCallback interface for receiving notification when a sound effect has finished loading. |
Public methods |
|
|---|---|
final void |
Adds a listener to be invoked when sounds finish loading. |
final void |
addLoadCompleteListener(Adds a listener to be invoked when sounds finish loading. |
void |
close() |
static final @NonNull SoundEffectPool |
Creates a |
final @NonNull SoundEffect |
load(@NonNull AssetFileDescriptor assetFileDescriptor)Loads a sound from an |
final @NonNull SoundEffect |
Loads a sound from an application resource and returns a |
final void |
release()Releases all native resources associated with this pool. |
final void |
Removes a listener previously added via |
final boolean |
unload(@NonNull SoundEffect soundEffect)Unloads a sound from memory to release resources. |
Public methods
addLoadCompleteListener
public final void addLoadCompleteListener(
@NonNull SoundEffectPool.LoadCompleteListener listener
)
Adds a listener to be invoked when sounds finish loading. The listener will be called on the main thread.
addLoadCompleteListener
public final void addLoadCompleteListener(
@NonNull Executor executor,
@NonNull SoundEffectPool.LoadCompleteListener listener
)
Adds a listener to be invoked when sounds finish loading. The listener will be called on the given Executor.
| Parameters | |
|---|---|
@NonNull Executor executor |
The |
@NonNull SoundEffectPool.LoadCompleteListener listener |
The |
create
public static final @NonNull SoundEffectPool create(@NonNull Session session, int maxStreams)
Creates a SoundEffectPool with the given session and maxStreams.
If the value of the maxStreams parameter exceeds the capabilities for the platform then the value will be clamped to the platform's max number of supported streams.
load
public final @NonNull SoundEffect load(@NonNull AssetFileDescriptor assetFileDescriptor)
Loads a sound from an AssetFileDescriptor and returns a SoundEffect handle.
Note: Loading is asynchronous. The sound may not be ready to play immediately after this method returns. Use LoadCompleteListener to be notified when it is ready.
| Parameters | |
|---|---|
@NonNull AssetFileDescriptor assetFileDescriptor |
the |
| Returns | |
|---|---|
@NonNull SoundEffect |
a |
load
public final @NonNull SoundEffect load(@NonNull Context context, int resId)
Loads a sound from an application resource and returns a SoundEffect handle.
Note: Loading is asynchronous. The sound may not be ready to play immediately after this method returns. Use LoadCompleteListener to be notified when it is ready.
| Parameters | |
|---|---|
@NonNull Context context |
the application context |
int resId |
resource ID of the sound (e.g., R.raw.sound) |
| Returns | |
|---|---|
@NonNull SoundEffect |
a |
release
public final void release()
Releases all native resources associated with this pool.
removeLoadCompleteListener
public final void removeLoadCompleteListener(
@NonNull SoundEffectPool.LoadCompleteListener listener
)
Removes a listener previously added via addLoadCompleteListener
unload
public final boolean unload(@NonNull SoundEffect soundEffect)
Unloads a sound from memory to release resources.
| Parameters | |
|---|---|
@NonNull SoundEffect soundEffect |
the |
| Returns | |
|---|---|
boolean |
true if the sound was successfully unloaded |