com.heckntarnation.rpgbattleengine.handlers

Class SoundHandler

java.lang.Object

com.heckntarnation.rpgbattleengine.handlers.SoundHandler

public class SoundHandler
extends Object

Author:

Ben

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SoundHandler.SoundThread

Field Summary

Fields

Modifier and Type	Field and Description
ArrayList<SoundHandler.SoundThread>	threads An array of all sound threads

Constructor Summary

Constructors

Constructor and Description
SoundHandler()

Method Summary

Modifier and Type	Method and Description
void	init()
void	mute() Mutes the sound
void	mute(int threadIndex) Mutes the sound of a specific thread
void	playSound(File file, int repeatTime)
void	playSound(InputStream stream, int repeatTime)
void	playSound(URI uri, int repeatTime) Starts a thread to play a sound, provided in the passed file, at the specified volume for the specified amount of time.
SoundHandler	setMaxThreads(int max) Sets the maximum amount of threads.
void	stopSound(int index) Stops a sound from playing.
void	stopSound(SoundHandler.SoundThread thread) Stops a sound from playing
void	unmute() Unmutes the sound.
void	unmute(int threadIndex) Unmutes the sound of a specific thread.

Methods inherited from class java.lang.Object

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

Field Detail

threads

public ArrayList<SoundHandler.SoundThread> threads

An array of all sound threads

Constructor Detail

SoundHandler

public SoundHandler()

Method Detail

init

public void init()

setMaxThreads

public SoundHandler setMaxThreads(int max)

Sets the maximum amount of threads. Make sure to be careful of the dreaded OutOfMemory error that can occur if too many threads exist.

Parameters:

max -

Returns:

playSound

public void playSound(URI uri,
                      int repeatTime)

Starts a thread to play a sound, provided in the passed file, at the specified volume for the specified amount of time.

Parameters:

uri -

repeatTime - (1 = repeat once, and -1 = play until stopSound() is called).

playSound

public void playSound(InputStream stream,
                      int repeatTime)

playSound

public void playSound(File file,
                      int repeatTime)

stopSound

public void stopSound(int index)

Stops a sound from playing.

Parameters:

index - (the index in the "threads" array)

stopSound

public void stopSound(SoundHandler.SoundThread thread)

Stops a sound from playing

Parameters:

thread - (a copy of the thread to stop)

mute

public void mute()

Mutes the sound

mute

public void mute(int threadIndex)

Mutes the sound of a specific thread

Parameters:

threadIndex -

unmute

public void unmute()

Unmutes the sound.

unmute

public void unmute(int threadIndex)

Unmutes the sound of a specific thread.

Parameters:

threadIndex -