kuusisto.tinysound.internal

Class StreamMusic

java.lang.Object

kuusisto.tinysound.internal.StreamMusic

All Implemented Interfaces:

Music

public class StreamMusic
extends Object
implements Music

The StreamMusic class is an implementation of the Music interface that streams audio data from a temporary file to reduce memory overhead.

Author:

Finn Kuusisto

Constructor Summary

Constructors

Constructor and Description
StreamMusic(URL dataURL, long numBytesPerChannel, Mixer mixer) Construct a new StreamMusic with the given data and the Mixer with which to register this StreamMusic.

Method Summary

Methods

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

StreamMusic

public StreamMusic(URL dataURL,
           long numBytesPerChannel,
           Mixer mixer)
            throws IOException

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

Parameters:

dataURL - URL of the temporary file containing audio data

numBytesPerChannel - the total number of bytes for each channel in the file

mixer - Mixer that will handle this StreamSound

Throws:

IOException - if a stream cannot be opened from the URL

Method Detail

play

public void play(boolean loop)

Play this StreamMusic and loop if specified.

Specified by:

play in interface Music

Parameters:

loop - if this StreamMusic should loop

play

public void play(boolean loop,
        double volume)

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

Specified by:

play in interface Music

Parameters:

loop - if this StreamMusic should loop

volume - the volume to play the this StreamMusic

play

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

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

Specified by:

play in interface Music

Parameters:

loop - if this StreamMusic should loop

volume - the volume to play the this StreamMusic

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

stop

public void stop()

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

Specified by:

stop in interface Music

pause

public void pause()

Stop playing this StreamMusic and keep its current position.

Specified by:

pause in interface Music

resume

public void resume()

Play this StreamMusic from its current position.

Specified by:

resume in interface Music

rewind

public void rewind()

Set this StreamMusic's position to the beginning.

Specified by:

rewind in interface Music

rewindToLoopPosition

public void rewindToLoopPosition()

Set this StreamMusic's position to the loop position.

Specified by:

rewindToLoopPosition in interface Music

playing

public boolean playing()

Determine if this StreamMusic is playing.

Specified by:

playing in interface Music

Returns:

true if this StreamMusic is playing

done

public boolean done()

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

Specified by:

done in interface Music

Returns:

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

loop

public boolean loop()

Determine if this StreamMusic will loop.

Specified by:

loop in interface Music

Returns:

true if this StreamMusic will loop

setLoop

public void setLoop(boolean loop)

Set whether this StreamMusic will loop.

Specified by:

setLoop in interface Music

Parameters:

loop - whether this StreamMusic will loop

getLoopPositionByFrame

public int getLoopPositionByFrame()

Get the loop position of this StreamMusic 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 StreamMusic 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 StreamMusic 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 StreamMusic 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 StreamMusic.

Specified by:

getVolume in interface Music

Returns:

volume of this StreamMusic

setVolume

public void setVolume(double volume)

Set the volume of this StreamMusic.

Specified by:

setVolume in interface Music

Parameters:

volume - the desired volume of this StreamMusic

getPan

public double getPan()

Get the pan of this StreamMusic.

Specified by:

getPan in interface Music

Returns:

pan of this StreamMusic

setPan

public void setPan(double pan)

Set the pan of this StreamMusic. 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 StreamMusic

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