uk.co.xfactorylibrarians.coremidi4j

Class CoreMidiDestination

java.lang.Object

uk.co.xfactorylibrarians.coremidi4j.CoreMidiDestination

All Implemented Interfaces:

AutoCloseable, MidiDevice

public class CoreMidiDestination
extends Object
implements MidiDevice

CoreMidiDestination - implementation for MidiDevice that can have any number of receivers but no transmitters.

See Also:

CoreMidiSource

Nested Class Summary

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

MidiDevice.Info

Field Summary

Fields

Modifier and Type	Field and Description
private CoreMidiDeviceInfo	info
private AtomicBoolean	isOpen
private Set<CoreMidiReceiver>	receivers
private AtomicLong	startTime

Constructor Summary

Constructors

Constructor and Description
CoreMidiDestination(CoreMidiDeviceInfo info) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Core MIDI Device, which also closes all of its receivers
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.
private long	getMicroSecondTime() Obtains the current system time in microseconds.
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
long	getStartTime() Obtains the time in microseconds at which this MIDI Device was opened.
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	open() Opens the Core MIDI Device
(package private) void	receiverClosed(CoreMidiReceiver receiver) Reacts to the closing of a receiver by removing it from the set of active receivers
(package private) void	updateDeviceInfo(CoreMidiDeviceInfo info) Changes the MIDI Info object; can only be done by this package as a result of a MIDI environment change event.

Methods inherited from class java.lang.Object

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

Field Detail

info

private CoreMidiDeviceInfo info

isOpen

private final AtomicBoolean isOpen

startTime

private final AtomicLong startTime

receivers

private final Set<CoreMidiReceiver> receivers

Constructor Detail

CoreMidiDestination

CoreMidiDestination(CoreMidiDeviceInfo info)

Default constructor.

Parameters:

info - CoreMidiDeviceInfo object providing details of the MIDI interface

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

updateDeviceInfo

void updateDeviceInfo(CoreMidiDeviceInfo info)

Changes the MIDI Info object; can only be done by this package as a result of a MIDI environment change event.

Parameters:

info - CoreMidiDeviceInfo object

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 accessed

close

public void close()

Closes the Core MIDI Device, which also closes all of its receivers

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()

getStartTime

public long getStartTime()

Obtains the time in microseconds at which this MIDI Device was opened.

Returns:

the time in microseconds that was recorded when this device was opened.

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. -1 is returned to indicate that the number is unlimited

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:

the list of receivers that have been created from this device that are still open

See Also:

MidiDevice.getReceivers()

receiverClosed

void receiverClosed(CoreMidiReceiver receiver)

Reacts to the closing of a receiver by removing it from the set of active receivers

Parameters:

receiver - the transmitter which is reporting itself as having closed

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 registered with this MIDI device

See Also:

MidiDevice.getTransmitters()

getMicroSecondTime

private long getMicroSecondTime()

Obtains the current system time in microseconds.

Returns:

The current system time in microseconds.