com.threerings.media.sound

Class JavaSoundPlayer

java.lang.Object

com.threerings.media.sound.SoundPlayer

com.threerings.media.sound.JavaSoundPlayer

Direct Known Subclasses:

SoundManager

public class JavaSoundPlayer
extends SoundPlayer

Manages the playing of audio files via the Java Sound APIs.

Nested Class Summary

Nested classes/interfaces inherited from class com.threerings.media.sound.SoundPlayer

SoundPlayer.Frob, SoundPlayer.SoundType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CACHE_SIZE The default clip cache holds 4 megs.

Fields inherited from class com.threerings.media.sound.SoundPlayer

DEFAULT, PAN_CENTER, PAN_LEFT, PAN_RIGHT

Constructor Summary

Constructors

Constructor and Description
JavaSoundPlayer(ResourceManager rmgr) Constructs a sound manager.
JavaSoundPlayer(ResourceManager rmgr, String defaultClipBundle, String defaultClipPath) Constructs a sound manager with the default clip cache size.
JavaSoundPlayer(ResourceManager rmgr, String defaultClipBundle, String defaultClipPath, int cacheSize) Constructs a sound manager.
JavaSoundPlayer(SoundLoader loader, int cacheSize)

Method Summary

Modifier and Type	Method and Description
RunQueue	getSoundQueue() Gets the run queue on which sound should be played.
void	lock(String pkgPath, String... keys) Optionally lock each of these keys prior to playing, to guarantee that it will be quickly available for playing.
void	setSoundQueue(RunQueue queue) Sets the run queue on which sound should be played.
static AudioInputStream	setupAudioStream(byte[] data) Sets up an audio stream from the given byte array, and gets it to convert itself to PCM data for writing to our output line (if it isn't already that)
static AudioInputStream	setupAudioStream(InputStream in) Sets up an audio stream from the given byte array, and gets it to convert itself to PCM data for writing to our output line (if it isn't already that)
void	shutdown() Shut the damn thing off.
void	unlock(String pkgPath, String... keys) Unlock the specified sounds so that its resources can be freed.

Methods inherited from class com.threerings.media.sound.SoundPlayer

addSoundEnabledObserver, getClipVolume, isEnabled, loop, loop, play, play, play, play, removeSoundEnabledObserver, setClipVolume, setEnabled, shouldPlay, summarizeState

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

The default clip cache holds 4 megs.

See Also:

Constant Field Values

Constructor Detail

JavaSoundPlayer

public JavaSoundPlayer(ResourceManager rmgr)

Constructs a sound manager.

JavaSoundPlayer

public JavaSoundPlayer(ResourceManager rmgr,
                       String defaultClipBundle,
                       String defaultClipPath)

Constructs a sound manager with the default clip cache size.

Parameters:

defaultClipPath - The pathname of a sound clip to use as a fallback if another sound clip cannot be located.

JavaSoundPlayer

public JavaSoundPlayer(ResourceManager rmgr,
                       String defaultClipBundle,
                       String defaultClipPath,
                       int cacheSize)

Constructs a sound manager.

Parameters:

defaultClipPath - The pathname of a sound clip to use as a fallback if another sound clip cannot be located.

cacheSize - the number of bytes of sound clips to cache.

JavaSoundPlayer

public JavaSoundPlayer(SoundLoader loader,
                       int cacheSize)

Method Detail

shutdown

public void shutdown()

Description copied from class: SoundPlayer

Shut the damn thing off.

Specified by:

shutdown in class SoundPlayer

setSoundQueue

public void setSoundQueue(RunQueue queue)

Sets the run queue on which sound should be played.

getSoundQueue

public RunQueue getSoundQueue()

Description copied from class: SoundPlayer

Gets the run queue on which sound should be played. It defaults to RunQueue.AWT.

lock

public void lock(String pkgPath,
                 String... keys)

Description copied from class: SoundPlayer

Optionally lock each of these keys prior to playing, to guarantee that it will be quickly available for playing.

Specified by:

lock in class SoundPlayer

unlock

public void unlock(String pkgPath,
                   String... keys)

Description copied from class: SoundPlayer

Unlock the specified sounds so that its resources can be freed.

Specified by:

unlock in class SoundPlayer

setupAudioStream

public static AudioInputStream setupAudioStream(byte[] data)
                                         throws UnsupportedAudioFileException,
                                                IOException

Sets up an audio stream from the given byte array, and gets it to convert itself to PCM data for writing to our output line (if it isn't already that)

Throws:

UnsupportedAudioFileException

IOException

setupAudioStream

public static AudioInputStream setupAudioStream(InputStream in)
                                         throws UnsupportedAudioFileException,
                                                IOException

Sets up an audio stream from the given byte array, and gets it to convert itself to PCM data for writing to our output line (if it isn't already that)

Throws:

UnsupportedAudioFileException

IOException