Class JSPISoundHandle

java.lang.Object

com.blackrook.gloop.openal.JSPISoundHandle

public class JSPISoundHandle
extends Object

Sound resource abstraction. Wraps Java Sound SPI structures for ease of creating handles to decodable sound.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JSPISoundHandle.Decoder	Decoder class that decodes sound as PCM audio.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JSPISoundHandle()
	JSPISoundHandle(File f)	Opens a sound file for reading.
	JSPISoundHandle(String filePath)	Opens a sound file for reading.
	JSPISoundHandle(String path, byte[] bytes)	Opens a URL for reading.
	JSPISoundHandle(URL url)	Opens a URL for reading.

Method Summary

Modifier and Type	Method	Description
final String	getDataName()
JSPISoundHandle.Decoder	getDecoder()
String	getName()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JSPISoundHandle

protected JSPISoundHandle()

JSPISoundHandle

public JSPISoundHandle(String filePath)
                throws IOException,
UnsupportedAudioFileException

Opens a sound file for reading.

Parameters:

filePath - path to the file.

Throws:

IOException - if the resource can't be read.

UnsupportedAudioFileException - if the audio format is not recognized.

JSPISoundHandle

public JSPISoundHandle(File f)
                throws IOException,
UnsupportedAudioFileException

Opens a sound file for reading.

Parameters:

f - the file.

Throws:

IOException - if the file can't be read.

UnsupportedAudioFileException - if the audio format is not recognized.

JSPISoundHandle

public JSPISoundHandle(URL url)
                throws IOException,
UnsupportedAudioFileException

Opens a URL for reading.

Parameters:

url - the URL.

Throws:

IOException - if the stream can't be read.

UnsupportedAudioFileException - if the audio format is not recognized.

JSPISoundHandle

public JSPISoundHandle(String path,
 byte[] bytes)
                throws IOException,
UnsupportedAudioFileException

Opens a URL for reading.

Parameters:

path - the original path.

bytes - the byte data to decode.

Throws:

IOException - if the stream can't be read.

UnsupportedAudioFileException - if the audio format is not recognized.

Method Details

getDecoder

public JSPISoundHandle.Decoder getDecoder()
                                   throws IOException

Returns:

a JSPISoundHandle.Decoder that can decode this data into PCM data.

Throws:

IOException - if a decoder could not be opened.

getName

public String getName()

Returns:

the name of this handle.

toString

public String toString()

Overrides:

toString in class Object

getDataName

public final String getDataName()

Returns:

the dataName