kuusisto.tinysound.internal

Interface MusicReference

public interface MusicReference

The MusicReference interface is the Mixer's interface to the audio data of a Music object. MusicReference 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 until the end of this Music.
void	dispose() Does any cleanup necessary to dispose of resources in use by this MusicReference.
boolean	done() Determine if there are no bytes remaining and play has stopped.
boolean	getLoop() Get the loop setting of this MusicReference.
long	getLoopPosition() Get the loop-position byte index of this MusicReference.
double	getPan() Get the pan of this MusicReference.
boolean	getPlaying() Get the playing setting of this MusicReference.
long	getPosition() Get the byte index of this MusicReference.
double	getVolume() Get the volume of this MusicReference.
void	nextTwoBytes(int[] data, boolean bigEndian) Get the next two bytes from the music data in the specified endianness.
void	setLoop(boolean loop) Set whether this MusicReference will loop.
void	setLoopPosition(long loopPosition) Set the loop-position byte index of this MusicReference.
void	setPan(double pan) Set the pan of this MusicReference.
void	setPlaying(boolean playing) Set whether this MusicReference is playing.
void	setPosition(long position) Set the byte index of this MusicReference.
void	setVolume(double volume) Set the volume of this MusicReference.
void	skipBytes(long num) Skip a specified number of bytes of the audio data.

Method Detail

getPlaying

boolean getPlaying()

Get the playing setting of this MusicReference.

Returns:

true if this MusicReference is set to play

getLoop

boolean getLoop()

Get the loop setting of this MusicReference.

Returns:

true if this MusicReference is set to loop

getPosition

long getPosition()

Get the byte index of this MusicReference.

Returns:

byte index of this MusicReference

getLoopPosition

long getLoopPosition()

Get the loop-position byte index of this MusicReference.

Returns:

loop-position byte index of this MusicReference

getVolume

double getVolume()

Get the volume of this MusicReference.

Returns:

volume of this MusicReference

getPan

double getPan()

Get the pan of this MusicReference.

Returns:

pan of this MusicReference

setPlaying

void setPlaying(boolean playing)

Set whether this MusicReference is playing.

Parameters:

playing - whether this MusicReference is playing

setLoop

void setLoop(boolean loop)

Set whether this MusicReference will loop.

Parameters:

loop - whether this MusicReference will loop

setPosition

void setPosition(long position)

Set the byte index of this MusicReference.

Parameters:

position - the byte index to set

setLoopPosition

void setLoopPosition(long loopPosition)

Set the loop-position byte index of this MusicReference.

Parameters:

loopPosition - the loop-position byte index to set

setVolume

void setVolume(double volume)

Set the volume of this MusicReference.

Parameters:

volume - the desired volume of this MusicReference

setPan

void setPan(double pan)

Set the pan of this MusicReference. Must be between -1.0 (full pan left) and 1.0 (full pan right).

Parameters:

pan - the desired pan of this MusicReference

bytesAvailable

long bytesAvailable()

Get the number of bytes remaining for each channel until the end of this Music.

Returns:

number of bytes remaining for each channel

done

boolean done()

Determine if there are no bytes remaining and play has stopped.

Returns:

true if there are no bytes remaining and the reference is no longer playing

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 music 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 MusicReference.