com.threerings.openal

Class ClipBuffer

java.lang.Object

com.threerings.openal.ClipBuffer

public class ClipBuffer
extends Object

Represents a sound that has been loaded into the OpenAL system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClipBuffer.Observer Used to notify parties interested in when a clip is loaded.

Constructor Summary

Constructors

Constructor and Description
ClipBuffer(SoundManager manager, ClipProvider provider, String path) Creates a new clip buffer with the specified path that will obtain its clip data from the specified source.

Method Summary

Modifier and Type	Method and Description
void	dispose() Frees up the internal audio buffers associated with this clip.
Buffer	getBuffer() Returns a reference to this clip's buffer or null if it is not loaded.
ClipProvider	getClipProvider() Returns the provider used to load this clip.
String	getKey() Returns the unique key for this clip buffer.
String	getPath() Returns the path that identifies this sound clip.
int	getSize() Returns the size (in bytes) of this clip as reported by OpenAL.
boolean	isPlayable() Returns true if this buffer is loaded and ready to go.
static String	makeKey(ClipProvider provider, String path) Create a key that uniquely identifies this combination of clip provider and path.
void	resolve(ClipBuffer.Observer observer) Instructs this buffer to resolve its underlying clip and be ready to be played ASAP.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipBuffer

public ClipBuffer(SoundManager manager,
                  ClipProvider provider,
                  String path)

Creates a new clip buffer with the specified path that will obtain its clip data from the specified source. The clip will automatically queue itself up to be loaded into memory.

Method Detail

makeKey

public static String makeKey(ClipProvider provider,
                             String path)

Create a key that uniquely identifies this combination of clip provider and path.

getKey

public String getKey()

Returns the unique key for this clip buffer.

getClipProvider

public ClipProvider getClipProvider()

Returns the provider used to load this clip.

getPath

public String getPath()

Returns the path that identifies this sound clip.

isPlayable

public boolean isPlayable()

Returns true if this buffer is loaded and ready to go.

getBuffer

public Buffer getBuffer()

Returns a reference to this clip's buffer or null if it is not loaded.

getSize

public int getSize()

Returns the size (in bytes) of this clip as reported by OpenAL. This value will not be valid until the clip is bound.

resolve

public void resolve(ClipBuffer.Observer observer)

Instructs this buffer to resolve its underlying clip and be ready to be played ASAP.

dispose

public void dispose()

Frees up the internal audio buffers associated with this clip.