kuusisto.tinysound.internal

Class StreamSound

java.lang.Object

kuusisto.tinysound.internal.StreamSound

All Implemented Interfaces:

Sound

public class StreamSound
extends Object
implements Sound

Thes StreamSound class is an implementation of the Sound interface that streams audio data from a temporary file to reduce memory overhead.

Author:

Finn Kuusisto

Constructor Summary

Constructors

Constructor and Description
StreamSound(URL dataURL, long numBytesPerChannel, Mixer mixer, int id) Construct a new StreamSound with the given data and Mixer which will handle this StreamSound.

Method Summary

Methods

Modifier and Type	Method and Description
void	play() Plays this StreamSound.
void	play(double volume) Plays this StreamSound with a specified volume.
void	play(double volume, double pan) Plays this MemSound with a specified volume and pan.
void	stop() Stops this StreamSound from playing.
void	unload() Unloads this StreamSound from the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamSound

public StreamSound(URL dataURL,
           long numBytesPerChannel,
           Mixer mixer,
           int id)
            throws IOException

Construct a new StreamSound with the given data and Mixer which will handle this StreamSound.

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

id - unique ID of this StreamSound

Throws:

IOException - if a stream cannot be opened from the URL

Method Detail

play

public void play()

Plays this StreamSound.

Specified by:

play in interface Sound

play

public void play(double volume)

Plays this StreamSound with a specified volume.

Specified by:

play in interface Sound

Parameters:

volume - the volume at which to play this StreamSound

play

public void play(double volume,
        double pan)

Plays this MemSound with a specified volume and pan.

Specified by:

play in interface Sound

Parameters:

volume - the volume at which to play this MemSound

pan - the pan value to play this MemSound [-1.0,1.0], values outside the valid range will assume no panning (0.0)

stop

public void stop()

Stops this StreamSound from playing. Note that if this StreamSound was played repeatedly in an overlapping fashion, all instances of this StreamSound still playing will be stopped.

Specified by:

stop in interface Sound

unload

public void unload()

Unloads this StreamSound from the system. Attempts to use this StreamSound after unloading will result in error.

Specified by:

unload in interface Sound