kuusisto.tinysound.internal

Interface SoundReference

public interface SoundReference

The SoundReference interface is the Mixer's interface to the audio data of a Sound object. SoundReference is an internal interface of the TinySound system and should be of no real concern to the average user of TinySound.

Author:

Finn Kuusisto

Method Summary

Methods

Modifier and Type	Method and Description
long	bytesAvailable() Get the number of bytes remaining for each channel.
void	dispose() Does any cleanup necessary to dispose of resources in use by this SoundReference.
double	getPan() Gets the pan of this SoundReference.
int	getSoundID() Get the ID of the Sound that produced this SoundReference.
double	getVolume() Gets the volume of this SoundReference.
void	nextTwoBytes(int[] data, boolean bigEndian) Get the next two bytes from the sound data in the specified endianness.
void	skipBytes(long num) Skip a specified number of bytes of the audio data.

Method Detail

getSoundID

int getSoundID()

Get the ID of the Sound that produced this SoundReference.

Returns:

the ID of this SoundReference's parent Sound

getVolume

double getVolume()

Gets the volume of this SoundReference.

Returns:

volume of this SoundReference

getPan

double getPan()

Gets the pan of this SoundReference.

Returns:

pan of this SoundReference

bytesAvailable

long bytesAvailable()

Get the number of bytes remaining for each channel.

Returns:

number of bytes remaining for each channel

skipBytes

void skipBytes(long num)

Skip a specified number of bytes of the audio data.

Parameters:

num - number of bytes to skip

nextTwoBytes

void nextTwoBytes(int[] data,
                boolean bigEndian)

Get the next two bytes from the sound data in the specified endianness.

Parameters:

data - length-2 array to write in next two bytes from each channel

bigEndian - true if the bytes should be read big-endian

dispose

void dispose()

Does any cleanup necessary to dispose of resources in use by this SoundReference.