kuusisto.tinysound.internal

Class MemMusic

java.lang.Object

kuusisto.tinysound.internal.MemMusic

All Implemented Interfaces:

Music

public class MemMusic
extends Object
implements Music

The MemMusic class is an implementation of the Music interface that stores all audio data in memory for low latency.

Author:

Finn Kuusisto

Constructor Summary

Constructors

Constructor and Description
MemMusic(byte[] left, byte[] right, Mixer mixer) Construct a new MemMusic with the given music data and the Mixer with which to register this MemMusic.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	done() Determine if this MemMusic has reached its end and is done playing.
int	getLoopPositionByFrame() Get the loop position of this MemMusic by sample frame.
double	getLoopPositionBySeconds() Get the loop position of this MemMusic by seconds.
double	getPan() Get the pan of this MemMusic.
double	getVolume() Get the volume of this MemMusic.
boolean	loop() Determine if this MemMusic will loop.
void	pause() Stop playing this MemMusic and keep its current position.
void	play(boolean loop) Play this MemMusic and loop if specified.
void	play(boolean loop, double volume) Play this MemMusic at the specified volume and loop if specified.
void	play(boolean loop, double volume, double pan) Play this MemMusic at the specified volume and pan, and loop if specified .
boolean	playing() Determine if this MemMusic is playing.
void	resume() Play this MemMusic from its current position.
void	rewind() Set this MemMusic's position to the beginning.
void	rewindToLoopPosition() Set this MemMusic's position to the loop position.
void	setLoop(boolean loop) Set whether this MemMusic will loop.
void	setLoopPositionByFrame(int frameIndex) Set the loop position of this MemMusic by sample frame.
void	setLoopPositionBySeconds(double seconds) Set the loop position of this MemMusic by seconds.
void	setPan(double pan) Set the pan of this MemMusic.
void	setVolume(double volume) Set the volume of this MemMusic.
void	stop() Stop playing this MemMusic and set its position to the beginning.
void	unload() Unload this MemMusic from the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemMusic

public MemMusic(byte[] left,
        byte[] right,
        Mixer mixer)

Construct a new MemMusic with the given music data and the Mixer with which to register this MemMusic.

Parameters:

left - left channel of music data

right - right channel of music data

mixer - Mixer with which this Music is registered

Method Detail

play

public void play(boolean loop)

Play this MemMusic and loop if specified.

Specified by:

play in interface Music

Parameters:

loop - if this MemMusic should loop

play

public void play(boolean loop,
        double volume)

Play this MemMusic at the specified volume and loop if specified.

Specified by:

play in interface Music

Parameters:

loop - if this MemMusic should loop

volume - the volume to play the this Music

play

public void play(boolean loop,
        double volume,
        double pan)

Play this MemMusic at the specified volume and pan, and loop if specified .

Specified by:

play in interface Music

Parameters:

loop - if this MemMusic should loop

volume - the volume to play the this MemMusic

pan - the pan at which to play this MemMusic [-1.0,1.0], values outside the valid range will be ignored

stop

public void stop()

Stop playing this MemMusic and set its position to the beginning.

Specified by:

stop in interface Music

pause

public void pause()

Stop playing this MemMusic and keep its current position.

Specified by:

pause in interface Music

resume

public void resume()

Play this MemMusic from its current position.

Specified by:

resume in interface Music

rewind

public void rewind()

Set this MemMusic's position to the beginning.

Specified by:

rewind in interface Music

rewindToLoopPosition

public void rewindToLoopPosition()

Set this MemMusic's position to the loop position.

Specified by:

rewindToLoopPosition in interface Music

playing

public boolean playing()

Determine if this MemMusic is playing.

Specified by:

playing in interface Music

Returns:

true if this MemMusic is playing

done

public boolean done()

Determine if this MemMusic has reached its end and is done playing.

Specified by:

done in interface Music

Returns:

true if this MemMusic has reached the end and is done playing

loop

public boolean loop()

Determine if this MemMusic will loop.

Specified by:

loop in interface Music

Returns:

true if this MemMusic will loop

setLoop

public void setLoop(boolean loop)

Set whether this MemMusic will loop.

Specified by:

setLoop in interface Music

Parameters:

loop - whether this MemMusic will loop

getLoopPositionByFrame

public int getLoopPositionByFrame()

Get the loop position of this MemMusic by sample frame.

Specified by:

getLoopPositionByFrame in interface Music

Returns:

loop position by sample frame

getLoopPositionBySeconds

public double getLoopPositionBySeconds()

Get the loop position of this MemMusic by seconds.

Specified by:

getLoopPositionBySeconds in interface Music

Returns:

loop position by seconds

setLoopPositionByFrame

public void setLoopPositionByFrame(int frameIndex)

Set the loop position of this MemMusic by sample frame.

Specified by:

setLoopPositionByFrame in interface Music

Parameters:

frameIndex - sample frame loop position to set

setLoopPositionBySeconds

public void setLoopPositionBySeconds(double seconds)

Set the loop position of this MemMusic by seconds.

Specified by:

setLoopPositionBySeconds in interface Music

Parameters:

seconds - loop position to set by seconds

getVolume

public double getVolume()

Get the volume of this MemMusic.

Specified by:

getVolume in interface Music

Returns:

volume of this MemMusic

setVolume

public void setVolume(double volume)

Set the volume of this MemMusic.

Specified by:

setVolume in interface Music

Parameters:

volume - the desired volume of this MemMusic

getPan

public double getPan()

Get the pan of this MemMusic.

Specified by:

getPan in interface Music

Returns:

pan of this MemMusic

setPan

public void setPan(double pan)

Set the pan of this MemMusic. Must be between -1.0 (full pan left) and 1.0 (full pan right). Values outside the valid range will be ignored.

Specified by:

setPan in interface Music

Parameters:

pan - the desired pan of this MemMusic

unload

public void unload()

Unload this MemMusic from the system. Attempts to use this MemMusic after unloading will result in error.

Specified by:

unload in interface Music