org.deken.game.sound.midi
Class MidiPlayer

java.lang.Object
  extended by org.deken.game.sound.midi.MidiPlayer
All Implemented Interfaces:
java.util.EventListener, javax.sound.midi.MetaEventListener

public class MidiPlayer
extends java.lang.Object
implements javax.sound.midi.MetaEventListener

Title: MidiPlayer

Description: TODO

Copyright: (c) 2007

Version:
1.0
Author:
Gary Deken

Field Summary
static int END_OF_TRACK_MESSAGE
           
 
Constructor Summary
MidiPlayer()
           
 
Method Summary
 void close()
          close Closes the sequencer
 javax.sound.midi.Sequence getSequence(java.lang.String filename)
          getSequence Loads a sequence from a file system.
 javax.sound.midi.Sequencer getSequencer()
          getSequencer
 boolean isPaused()
          isPaused
 void meta(javax.sound.midi.MetaMessage meta)
          meta This method is called by the sound system when a meta event occurs.
 void play(javax.sound.midi.Sequence sequence, boolean loop)
          play plays a sequence, optionally looping.
 void setPaused(boolean paused)
          setPaused Music is not immediately paused.
 void stop()
          stop Stops the sequencer, and resets it.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

END_OF_TRACK_MESSAGE

public static final int END_OF_TRACK_MESSAGE
See Also:
Constant Field Values
Constructor Detail

MidiPlayer

public MidiPlayer()
Method Detail

getSequence

public javax.sound.midi.Sequence getSequence(java.lang.String filename)
getSequence Loads a sequence from a file system. Returns null is not found.

Parameters:
filename - String
Returns:
Sequence

play

public void play(javax.sound.midi.Sequence sequence,
                 boolean loop)
play plays a sequence, optionally looping. This method returns immediately. Invalid sequences do not play.

Parameters:
sequence - Sequence
loop - boolean

meta

public void meta(javax.sound.midi.MetaMessage meta)
meta This method is called by the sound system when a meta event occurs. In this case, when the end-of-track meta event is received, the sequence is restarted if looping is on.

Specified by:
meta in interface javax.sound.midi.MetaEventListener
Parameters:
meta - MetaMessage

stop

public void stop()
stop Stops the sequencer, and resets it.


close

public void close()
close Closes the sequencer


getSequencer

public javax.sound.midi.Sequencer getSequencer()
getSequencer

Returns:
Sequencer

setPaused

public void setPaused(boolean paused)
setPaused Music is not immediately paused.

Parameters:
paused - boolean

isPaused

public boolean isPaused()
isPaused

Returns:
boolean