com.threerings.openal

Class SoundGroup

java.lang.Object

com.threerings.openal.SoundGroup

public class SoundGroup
extends Object

Manages a group of sounds, binding them to OpenAL sources as they are played and freeing up those sources for use by other sounds when the sounds are finished.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes this sound group, freeing up the OpenAL sources with which it is associated.
float	getBaseGain() Returns the base gain for this group, or -1 if inherited from the manager.
Sound	getSound(String path) Obtains an "instance" of the specified sound which can be positioned, played, looped and otherwise used to make noise.
void	preloadClip(String path) Queues up the specified sound clip for pre-loading into the cache.
void	reclaimAll() Stops and reclaims all sounds from this sound group but does not free the sources.
void	setBaseGain(float gain) Sets the base gain for this group, or -1 to inherit from the manager (the default).

Methods inherited from class java.lang.Object

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

Method Detail

setBaseGain

public void setBaseGain(float gain)

Sets the base gain for this group, or -1 to inherit from the manager (the default).

getBaseGain

public float getBaseGain()

Returns the base gain for this group, or -1 if inherited from the manager.

preloadClip

public void preloadClip(String path)

Queues up the specified sound clip for pre-loading into the cache.

getSound

public Sound getSound(String path)

Obtains an "instance" of the specified sound which can be positioned, played, looped and otherwise used to make noise.

dispose

public void dispose()

Disposes this sound group, freeing up the OpenAL sources with which it is associated. All sounds obtained from this group will no longer be usable and should be discarded.

reclaimAll

public void reclaimAll()

Stops and reclaims all sounds from this sound group but does not free the sources.