com.moppyandroid.main.service

Class MoppyManager

java.lang.Object

com.moppyandroid.main.service.MoppyManager

All Implemented Interfaces:

StatusConsumer, AutoCloseable

public class MoppyManager
extends Object
implements StatusConsumer, AutoCloseable

Manages all objects necessary to operate Moppy and provides methods to control them.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MoppyManager.Callback Callbacks fired when each method has completed successfully.

Constructor Summary

Constructors

Constructor and Description
MoppyManager(Context context) Constructs a new MoppyManager.

Method Summary

Modifier and Type	Method and Description
boolean	addReceiver(Receiver receiver) Adds a Receiver to forward all MIDI messages to, regardless of if they originated on the MIDI wire input or the MIDI file input.
void	close() Releases held resources.
Receiver	getInputReceiver() Gets the Receiver that can be used to send MIDI messages to Moppy.
MidiLibrary.MidiFile	getLoadedFile() Gets the currently loaded MidiLibrary.MidiFile.
long	getMillisecondsLength() Uses the calculations of the loaded Sequence to get the song length.
long	getMillisecondsPosition() Gets the current position within the loaded song.
Receiver	getReceiver() Gets the ReceiverDispatcher that messages are forwarded to.
boolean	isPlaying() Checks if the Sequencer is playing.
void	load(MidiLibrary.MidiFile file, Context context) Loads a MidiLibrary.MidiFile into the sequencer.
void	pause() Pauses playback if not already paused.
void	play() Starts playback if not already playing.
void	receiveUpdate(StatusUpdate update) Triggered when the sequencer posts a StatusUpdate.
void	registerCallback(MoppyManager.Callback callback) Registers a MoppyManager.Callback with this MoppyManager to receive calls upon method completion.
boolean	removeReceiver(Receiver receiver) Removes a Receiver from the list to forward messages to.
void	seekTo(long millis, boolean callPlay) Seeks to the provided millisecond position within the loaded song.
void	stop() Stops and resets playback.
boolean	unregisterCallback(MoppyManager.Callback callback) Removes a MoppyManager.Callback registered with this MoppManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

MoppyManager

public MoppyManager(Context context)
             throws MidiUnavailableException

Constructs a new MoppyManager.

Parameters:

context - the context to create the MoppyManager in

Throws:

MidiUnavailableException - if a MoppyMIDISequencer cannot be created

Method Detail

receiveUpdate

public void receiveUpdate(StatusUpdate update)

Triggered when the sequencer posts a StatusUpdate.

Specified by:

receiveUpdate in interface StatusConsumer

Parameters:

update - the posted StatusUpdate

close

public void close()

Releases held resources. MUST be called before this MoppyManager's destruction.

Specified by:

close in interface AutoCloseable

play

public void play()

Starts playback if not already playing.

pause

public void pause()

Pauses playback if not already paused.

stop

public void stop()

Stops and resets playback. A StatusType.SEQUENCE_STOPPED message is broadcasted to all registered StatusConsumers, and connected Moppy devices are sent a MoppyMessage.SYS_RESET message.

load

public void load(MidiLibrary.MidiFile file,
                 Context context)
          throws IOException,
                 InvalidMidiDataException

Loads a MidiLibrary.MidiFile into the sequencer.

Parameters:

file - the file to load

context - the Context to use to open the file

Throws:

IOException - if the file couldn't be opened

InvalidMidiDataException - if the file wasn't a valid MIDI file

getMillisecondsLength

public long getMillisecondsLength()

Uses the calculations of the loaded Sequence to get the song length.

Returns:

the length in milliseconds

getMillisecondsPosition

public long getMillisecondsPosition()

Gets the current position within the loaded song.

Returns:

the position in milliseconds

seekTo

public void seekTo(long millis,
                   boolean callPlay)

Seeks to the provided millisecond position within the loaded song. If millis is greater than the length of the song, the Sequencer is advanced to the end of the song. Since reaching the end of the song automatically pauses the Sequencer, the parameter callPlay is provided to allow the caller to automatically restart playback after the seek.

Parameters:

millis - the position to seek to

callPlay - true to ensure the Sequencer is playing, false to not alter the playback state

isPlaying

public boolean isPlaying()

Checks if the Sequencer is playing.

Returns:

true if playing, otherwise false

getLoadedFile

public MidiLibrary.MidiFile getLoadedFile()

Gets the currently loaded MidiLibrary.MidiFile.

Returns:

the loaded MidiFile

getInputReceiver

public Receiver getInputReceiver()

Gets the Receiver that can be used to send MIDI messages to Moppy.

Returns:

the Receiver to send messages to

getReceiver

public Receiver getReceiver()

Gets the ReceiverDispatcher that messages are forwarded to.

Returns:

the ReceiverDispatcher as a Receiver

See Also:

addReceiver(Receiver), removeReceiver(Receiver)

addReceiver

public boolean addReceiver(Receiver receiver)

Adds a Receiver to forward all MIDI messages to, regardless of if they originated on the MIDI wire input or the MIDI file input. See ReceiverDispatcher.add(Receiver) for more information.

Parameters:

receiver - the Receiver to add

Returns:

true if receiver was added, false if receiver was null or duplicate

See Also:

removeReceiver(Receiver)

removeReceiver

public boolean removeReceiver(Receiver receiver)

Removes a Receiver from the list to forward messages to.

Parameters:

receiver - the Receiver to remove

Returns:

true if receiver was removed, false if it was null or not added

See Also:

addReceiver(Receiver)

registerCallback

public void registerCallback(MoppyManager.Callback callback)

Registers a MoppyManager.Callback with this MoppyManager to receive calls upon method completion.

Parameters:

callback - the Callback instance to register

unregisterCallback

public boolean unregisterCallback(MoppyManager.Callback callback)

Removes a MoppyManager.Callback registered with this MoppManager.

Parameters:

callback - the Callback instance to unregister

Returns:

true if callback was formerly registered, otherwise false

See Also:

registerCallback(Callback)