com.threerings.openal

Class SoundManager

java.lang.Object

com.threerings.openal.SoundManager

public class SoundManager
extends Object

An interface to the OpenAL library that provides a number of additional services:

• an object oriented interface to the OpenAL system
• a mechanism for loading a group of sounds and freeing their resources all at once
• a mechanism for loading sounds in a background thread and preloading sounds that are likely to be needed soon

Note: the sound manager is not thread safe (other than during its interactions with its internal background loading thread). It assumes that all sound loading and play requests will be made from a single thread.

Method Summary

Modifier and Type	Method and Description
SoundGroup	createGroup(ClipProvider provider, int sources) Creates an object that can be used to manage and play a group of sounds.
static SoundManager	createSoundManager(RunQueue rqueue) Creates, initializes and returns the singleton sound manager instance.
float	getBaseGain() Returns the base gain used for sound effects (not music).
Listener	getListener() Returns a reference to the listener object.
ArrayList<Stream>	getStreams() Returns a reference to the list of active streams.
boolean	isInitialized() Returns true if we were able to initialize the sound system.
void	loadClip(ClipProvider provider, String path) Loads a clip buffer for the sound clip loaded via the specified provider with the specified path.
void	loadClip(ClipProvider provider, String path, ClipBuffer.Observer observer) Loads a clip buffer for the sound clip loaded via the specified provider with the specified path.
void	setBaseGain(float gain) Configures the base gain (which must be a value between 0 and 1.0) which is multiplied to the individual gain assigned to sound effects (but not music).
void	setCacheSize(int bytes) Configures the size of our sound cache.
void	shutdown() Shuts down the sound manager.
void	updateStreams(float time) Updates all of the streams controlled by the manager.

Methods inherited from class java.lang.Object

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

Method Detail

createSoundManager

public static SoundManager createSoundManager(RunQueue rqueue)

Creates, initializes and returns the singleton sound manager instance.

Parameters:

rqueue - a queue that the sound manager can use to post short runnables that must be executed on the same thread from which all other sound methods will be called.

shutdown

public void shutdown()

Shuts down the sound manager.

isInitialized

public boolean isInitialized()

Returns true if we were able to initialize the sound system.

setCacheSize

public void setCacheSize(int bytes)

Configures the size of our sound cache. If this value is larger than memory available to the underlying sound system, it will be reduced when OpenAL first tells us we're out of memory.

getListener

public Listener getListener()

Returns a reference to the listener object.

setBaseGain

public void setBaseGain(float gain)

Configures the base gain (which must be a value between 0 and 1.0) which is multiplied to the individual gain assigned to sound effects (but not music).

getBaseGain

public float getBaseGain()

Returns the base gain used for sound effects (not music).

createGroup

public SoundGroup createGroup(ClipProvider provider,
                              int sources)

Creates an object that can be used to manage and play a group of sounds. Note: the sound group must be disposed when it is no longer needed via a call to SoundGroup.dispose().

Parameters:

provider - indicates from where the sound group will load its sounds.

sources - indicates the maximum number of simultaneous sounds that can play in this group.

getStreams

public ArrayList<Stream> getStreams()

Returns a reference to the list of active streams.

updateStreams

public void updateStreams(float time)

Updates all of the streams controlled by the manager. This should be called once per frame by the application.

Parameters:

time - the number of seconds elapsed since the last update

loadClip

public void loadClip(ClipProvider provider,
                     String path)

Loads a clip buffer for the sound clip loaded via the specified provider with the specified path. The loaded clip is placed in the cache.

loadClip

public void loadClip(ClipProvider provider,
                     String path,
                     ClipBuffer.Observer observer)

Loads a clip buffer for the sound clip loaded via the specified provider with the specified path. The loaded clip is placed in the cache.