uk.co.dolphin_com.seescoreandroid

Class Dispatcher

java.lang.Object

uk.co.dolphin_com.seescoreandroid.Dispatcher

public class Dispatcher
extends java.lang.Object

dispatch events driven by SeeScore PlayData (bar start, beat, note, play end)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Dispatcher.EventHandler a generic handler for bar start, beat and end
static interface	Dispatcher.NoteEventHandler a handler for notes starting
static class	Dispatcher.State the state of the dispatcher

Constructor Summary

Constructors

Constructor and Description
Dispatcher(PlayData playData, java.lang.Runnable playEndHandler) construct the Dispatcher

Method Summary

Modifier and Type	Method and Description
int	barStartTime(int barIndex) time in ms from the start of the score to the start of the bar
int	currentBar() get the last bar which was dispatched
void	setBarStartHandler(Dispatcher.EventHandler handler, int delay_ms) register an event handler to be called at the start of each bar
void	setBeatHandler(Dispatcher.EventHandler handler, int delay_ms) register an event handler to be called on each beat in the bar
void	setEndHandler(Dispatcher.EventHandler handler, int delay_ms) register an event handler to be called on completion of play.
void	setNoteHandler(Dispatcher.NoteEventHandler handler, int delay_ms) register an event handler to be called on the start of new note/chord This can be used to move a cursor onto each note as it is played.
void	startAt(java.util.Date startTime, int barIndex, boolean countIn) start dispatching at the given start time.
Dispatcher.State	state() the current state of the Dispatcher
void	stop() stop dispatching

Methods inherited from class java.lang.Object

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

Constructor Detail

Dispatcher

public Dispatcher(PlayData playData,
                  java.lang.Runnable playEndHandler)

construct the Dispatcher

Parameters:

playData - the PlayData derived from the score

playEndHandler - a handler to call on true end of play to update state in the caller NB This is not the same as the registered end handler which may have an associated delay

Method Detail

state

public Dispatcher.State state()

the current state of the Dispatcher

Returns:

the state, Started or Stopped

startAt

public void startAt(java.util.Date startTime,
                    int barIndex,
                    boolean countIn)

start dispatching at the given start time. The bar start handler will be called for the first bar at startTime

Parameters:

startTime - the time to start

barIndex - the 0-based bar index to start at

countIn - if true a count-in bar (copy of the barIndex bar with a maximum of 4 beats and the count-in flag set) is played first

stop

public void stop()

stop dispatching

currentBar

public int currentBar()

get the last bar which was dispatched

Returns:

the current bar

barStartTime

public int barStartTime(int barIndex)

time in ms from the start of the score to the start of the bar

Returns:

ms time to the bar

setBarStartHandler

public void setBarStartHandler(Dispatcher.EventHandler handler,
                               int delay_ms)

register an event handler to be called at the start of each bar

Parameters:

handler - the handler to be called at the start of each bar

delay_ms - a millisecond delay for the handler call, which can be negative to anticipate the bar change eg for an animated cursor

setBeatHandler

public void setBeatHandler(Dispatcher.EventHandler handler,
                           int delay_ms)

register an event handler to be called on each beat in the bar

Parameters:

handler - the handler to be called on each beat

delay_ms - a millisecond delay for the handler call, which can be negative to anticipate the event

setEndHandler

public void setEndHandler(Dispatcher.EventHandler handler,
                          int delay_ms)

register an event handler to be called on completion of play. NB It is not called when the dispatcher is stopped by a call to stop

Parameters:

handler - the handler to be called at the end of play

delay_ms - a millisecond delay for the handler call, which can be negative to anticipate the event

setNoteHandler

public void setNoteHandler(Dispatcher.NoteEventHandler handler,
                           int delay_ms)

register an event handler to be called on the start of new note/chord This can be used to move a cursor onto each note as it is played. NB for a piece with many fast notes you need to ensure your handler is fast enough to handle the throughput.

Parameters:

handler - the handler to be called at the start of each note

delay_ms - a millisecond delay for the handler call, which can be negative to anticipate the event