kuusisto.tinysound.internal

Class MemSound

java.lang.Object

kuusisto.tinysound.internal.MemSound

All Implemented Interfaces:

Sound

public class MemSound
extends Object
implements Sound

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

Author:

Finn Kuusisto

Constructor Summary

Constructors

Constructor and Description
MemSound(byte[] left, byte[] right, Mixer mixer, int id) Construct a new MemSound with the given data and Mixer which will handle this MemSound.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MemSound

public MemSound(byte[] left,
        byte[] right,
        Mixer mixer,
        int id)

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

Parameters:

left - left channel of sound data

right - right channel of sound data

mixer - Mixer that will handle this MemSound

id - unique ID of this MemSound

Method Detail

play

public void play()

Plays this MemSound.

Specified by:

play in interface Sound

play

public void play(double volume)

Plays this MemSound with a specified volume.

Specified by:

play in interface Sound

Parameters:

volume - the volume at which to play this MemSound

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 MemSound from playing. Note that if this MemSound was played repeatedly in an overlapping fashion, all instances of this MemSound still playing will be stopped.

Specified by:

stop in interface Sound

unload

public void unload()

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

Specified by:

unload in interface Sound