com.realtime.crossfire.jxclient.sound

Class ClipManager

java.lang.Object

com.realtime.crossfire.jxclient.sound.ClipManager

public class ClipManager
extends java.lang.Object

Manages a set of sound clips (short sound effects). Multiple sound effects can be played simultaneously.

Constructor Summary

Constructors

Constructor and Description
ClipManager(@NotNull AudioFileLoader audioFileLoader, @Nullable DebugWriter debugSound, @NotNull SoundTaskExecutor soundTaskExecutor) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	play(@NotNull java.lang.CharSequence action) Plays the given sound effect.
void	shutdown() Terminates all running clips and free resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipManager

public ClipManager(@NotNull
                   @NotNull AudioFileLoader audioFileLoader,
                   @Nullable
                   @Nullable DebugWriter debugSound,
                   @NotNull
                   @NotNull SoundTaskExecutor soundTaskExecutor)

Creates a new instance.

Parameters:

audioFileLoader - the audio file loader for loading audio files

debugSound - the writer for logging sound related information or null to not log

soundTaskExecutor - the global sound task executor

Method Detail

play

public void play(@NotNull
                 @NotNull java.lang.CharSequence action)

Plays the given sound effect. This function returns immediately.

Parameters:

action - the action name of the sound effect

shutdown

public void shutdown()
              throws java.lang.InterruptedException

Terminates all running clips and free resources.

Throws:

java.lang.InterruptedException - if the current thread was interrupted while waiting for the shutdown