com.threerings.openal

Class OpenALSoundPlayer

java.lang.Object

com.threerings.media.sound.SoundPlayer

com.threerings.openal.OpenALSoundPlayer

All Implemented Interfaces:

ClipProvider

public class OpenALSoundPlayer
extends SoundPlayer
implements ClipProvider

Implements the abstract pieces of SoundPlayer via OpenAL.

Nested Class Summary

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

SoundPlayer.Frob, SoundPlayer.SoundType

Field Summary

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

DEFAULT, PAN_CENTER, PAN_LEFT, PAN_RIGHT

Constructor Summary

Constructors

Constructor and Description
OpenALSoundPlayer(SoundLoader loader)

Method Summary

Modifier and Type	Method and Description
SoundLoader	getSoundLoader() Returns the loader used by this player.
RunQueue	getSoundQueue() Gets the run queue on which sound should be played.
Clip	loadClip(String path) Loads the specified clip from the appropriate source.
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.
SoundPlayer.Frob	loop(SoundPlayer.SoundType type, String pkgPath, String key, float gain, float[] pos)
SoundPlayer.Frob	loop(String pkgPath, String key, float pan) Loop the specified sound, stopping as quickly as possible when stop is called.
SoundPlayer.Frob	loop(String pkgPath, String key, float pan, float gain)
boolean	play(SoundPlayer.SoundType type, String pkgPath, String key, float gain, float[] pos)
void	play(String pkgPath, String key, float pan) Play the specified sound after the specified delay.
void	play(String pkgPath, String key, float pan, float gain)
void	setClipVolume(float vol) Sets the volume for all sound clips.
void	shutdown() Shut the damn thing off.
void	stream(String bundle, String path, boolean loop, ResultListener<Stream> listener) Streams ogg files from the given bundle and path.
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, setEnabled, shouldPlay, summarizeState

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenALSoundPlayer

public OpenALSoundPlayer(SoundLoader loader)

Method Detail

loadClip

public Clip loadClip(String path)
              throws IOException

Description copied from interface: ClipProvider

Loads the specified clip from the appropriate source.

Specified by:

loadClip in interface ClipProvider

Throws:

IOException

getSoundLoader

public SoundLoader getSoundLoader()

Returns the loader used by this player.

getSoundQueue

public RunQueue getSoundQueue()

Description copied from class: SoundPlayer

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

setClipVolume

public void setClipVolume(float vol)

Description copied from class: SoundPlayer

Sets the volume for all sound clips.

Overrides:

setClipVolume in class SoundPlayer

Parameters:

vol - a volume parameter between 0f and 1f, inclusive.

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

stream

public void stream(String bundle,
                   String path,
                   boolean loop,
                   ResultListener<Stream> listener)
            throws IOException

Streams ogg files from the given bundle and path.

Throws:

IOException

loop

public SoundPlayer.Frob loop(String pkgPath,
                             String key,
                             float pan)

Description copied from class: SoundPlayer

Loop the specified sound, stopping as quickly as possible when stop is called.

loop

public SoundPlayer.Frob loop(String pkgPath,
                             String key,
                             float pan,
                             float gain)

loop

public SoundPlayer.Frob loop(SoundPlayer.SoundType type,
                             String pkgPath,
                             String key,
                             float gain,
                             float[] pos)

play

public void play(String pkgPath,
                 String key,
                 float pan)

Description copied from class: SoundPlayer

Play the specified sound after the specified delay.

pan - a value from -1f (all left) to +1f (all right).

play

public void play(String pkgPath,
                 String key,
                 float pan,
                 float gain)

play

public boolean play(SoundPlayer.SoundType type,
                    String pkgPath,
                    String key,
                    float gain,
                    float[] pos)

shutdown

public void shutdown()

Description copied from class: SoundPlayer

Shut the damn thing off.

Specified by:

shutdown in class SoundPlayer