kuusisto.tinysound.internal

Class Mixer

java.lang.Object

kuusisto.tinysound.internal.Mixer

public class Mixer
extends Object

The Mixer class is what does the audio data mixing for the TinySound system. Mixer is an internal class of the TinySound system and should be of no real concern to the average user of TinySound.

Author:

Finn Kuusisto

Constructor Summary

Constructors

Constructor and Description
Mixer() Construct a new Mixer for TinySound system.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearMusic() Unregister all Music registered with this Mixer.
void	clearSounds() Unregister all Sounds registered with this Mixer.
double	getVolume() Get the global volume for this Mixer.
int	read(byte[] data, int offset, int length) Read bytes from this Mixer.
void	registerMusicReference(MusicReference music) Registers a MusicReference with this Mixer.
void	registerSoundReference(SoundReference sound) Registers a SoundReference with this Mixer.
void	setVolume(double volume) Set the global volume for this Mixer.
void	skip(int numBytes) Skip specified number of bytes of all audio in this Mixer.
void	unRegisterMusicReference(MusicReference music) Unregisters a MusicReference with this Mixer.
void	unRegisterSoundReference(int soundID) Unregisters all SoundReferences with a given soundID.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mixer

public Mixer()

Construct a new Mixer for TinySound system.

Method Detail

getVolume

public double getVolume()

Get the global volume for this Mixer.

Returns:

the global volume

setVolume

public void setVolume(double volume)

Set the global volume for this Mixer.

Parameters:

volume - the global volume to set

registerMusicReference

public void registerMusicReference(MusicReference music)

Registers a MusicReference with this Mixer.

Parameters:

music - MusicReference to be registered

registerSoundReference

public void registerSoundReference(SoundReference sound)

Registers a SoundReference with this Mixer.

Parameters:

sound - SoundReference to be registered

unRegisterMusicReference

public void unRegisterMusicReference(MusicReference music)

Unregisters a MusicReference with this Mixer.

Parameters:

music - MusicReference to be unregistered

unRegisterSoundReference

public void unRegisterSoundReference(int soundID)

Unregisters all SoundReferences with a given soundID.

Parameters:

soundID - ID of SoundReferences to be unregistered

clearMusic

public void clearMusic()

Unregister all Music registered with this Mixer.

clearSounds

public void clearSounds()

Unregister all Sounds registered with this Mixer.

read

public int read(byte[] data,
       int offset,
       int length)

Read bytes from this Mixer.

Parameters:

data - the buffer to read the bytes into

offset - the start index to read bytes into

length - the maximum number of bytes that should be read

Returns:

number of bytes read into buffer

skip

public void skip(int numBytes)

Skip specified number of bytes of all audio in this Mixer.

Parameters:

numBytes - the number of bytes to skip