Package uk.co.xfactorylibrarians.coremidi4j

Class CoreMidiSource

java.lang.Object

uk.co.xfactorylibrarians.coremidi4j.CoreMidiSource

All Implemented Interfaces:

AutoCloseable, MidiDevice

public class CoreMidiSource
extends Object
implements MidiDevice

Provides a working Java MIDI interface to a CoreMIDI device to which we can send messages.

Nested Class Summary

Nested classes/interfaces inherited from interface javax.sound.midi.MidiDevice

MidiDevice.Info

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the Core MIDI Device, which also closes all its transmitters
MidiDevice.Info	getDeviceInfo()	Gets the MIDI Info object
int	getMaxReceivers()	Gets the maximum number of receivers that can be attached to this device.
int	getMaxTransmitters()	Gets the maximum number of transmitters that can be attached to this device.
long	getMicrosecondPosition()	Obtains the time in microseconds that has elapsed since this MIDI Device was opened.
Receiver	getReceiver()	Creates and returns a MIDI Receiver for use with this Device
List<Receiver>	getReceivers()	Gets a list of receivers connected to the device
Transmitter	getTransmitter()	Gets a transmitter for this device (which is also added to the internal list)
List<Transmitter>	getTransmitters()	Gets the list of transmitters registered with this MIDI device
boolean	isOpen()	Checks to see if the MIDI Device is open
void	messageCallback(long coreTimestamp, int packetlength, byte[] data)	The message callback for receiving midi data from the JNI code
void	open()	Opens the Core MIDI Device

Methods inherited from class java.lang.Object

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

Method Detail

getDeviceInfo

public MidiDevice.Info getDeviceInfo()

Gets the MIDI Info object

Specified by:

getDeviceInfo in interface MidiDevice

Returns:

the MIDI Info object, which provides details about the interface

open

public void open()
          throws MidiUnavailableException

Opens the Core MIDI Device

Specified by:

open in interface MidiDevice

Throws:

MidiUnavailableException - if the MIDI system cannot be used

close

public void close()

Closes the Core MIDI Device, which also closes all its transmitters

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MidiDevice

isOpen

public boolean isOpen()

Checks to see if the MIDI Device is open

Specified by:

isOpen in interface MidiDevice

Returns:

true if the device is open, otherwise false;

See Also:

MidiDevice.isOpen()

getMicrosecondPosition

public long getMicrosecondPosition()

Obtains the time in microseconds that has elapsed since this MIDI Device was opened.

Specified by:

getMicrosecondPosition in interface MidiDevice

Returns:

the time in microseconds that has elapsed since this MIDI Device was opened.

See Also:

MidiDevice.getMicrosecondPosition()

getMaxReceivers

public int getMaxReceivers()

Gets the maximum number of receivers that can be attached to this device.

Specified by:

getMaxReceivers in interface MidiDevice

Returns:

the maximum number of receivers that can be attached to this device. This is always 0 as a CoreMidiSource has no receivers

See Also:

MidiDevice.getMaxReceivers()

getMaxTransmitters

public int getMaxTransmitters()

Gets the maximum number of transmitters that can be attached to this device.

Specified by:

getMaxTransmitters in interface MidiDevice

Returns:

the maximum number of transmitters that can be attached to this device. -1 is returned to indicate that the number is unlimited

See Also:

MidiDevice.getMaxTransmitters()

getReceiver

public Receiver getReceiver()
                     throws MidiUnavailableException

Creates and returns a MIDI Receiver for use with this Device

Specified by:

getReceiver in interface MidiDevice

Returns:

the created receiver

Throws:

MidiUnavailableException

See Also:

MidiDevice.getReceiver()

getReceivers

public List<Receiver> getReceivers()

Gets a list of receivers connected to the device

Specified by:

getReceivers in interface MidiDevice

Returns:

an empty list - we do not maintain a list of receivers

See Also:

MidiDevice.getReceivers()

getTransmitter

public Transmitter getTransmitter()
                           throws MidiUnavailableException

Gets a transmitter for this device (which is also added to the internal list)

Specified by:

getTransmitter in interface MidiDevice

Returns:

a transmitter for this device

Throws:

MidiUnavailableException

See Also:

MidiDevice.getTransmitter()

getTransmitters

public List<Transmitter> getTransmitters()

Gets the list of transmitters registered with this MIDI device

Specified by:

getTransmitters in interface MidiDevice

Returns:

The list of transmitters created from this MIDI device that are still open

See Also:

MidiDevice.getTransmitters()

messageCallback

public void messageCallback(long coreTimestamp,
                            int packetlength,
                            byte[] data)
                     throws InvalidMidiDataException

The message callback for receiving midi data from the JNI code

Parameters:

coreTimestamp - The time in microseconds since boot at which the messages should take effect

packetlength - The length of the packet of messages

data - The data array that holds the messages

Throws:

InvalidMidiDataException - if the message contained values that could not be interpreted as valid MIDI