uk.co.xfactorylibrarians.coremidi4j

Class CoreMidiInputPort

java.lang.Object

uk.co.xfactorylibrarians.coremidi4j.CoreMidiInputPort

public class CoreMidiInputPort
extends Object

CoreMidiInputPort class

Field Summary

Fields

Modifier and Type	Field and Description
private long	memoryHandle For each connection to an OSX EndPoint, some data is allocated on the native side.
private int	midiPortReference The OSX MIDI port reference

Constructor Summary

Constructors

Constructor and Description
CoreMidiInputPort(int clientReference, String portName) Constructor

Method Summary

Modifier and Type	Method and Description
void	connectSource(CoreMidiSource sourceDevice) Connects a source to this input port
private int	createInputPort(int clientReference, String portName) Creates a CoreMIDI input port
void	disconnectSource(CoreMidiSource sourceDevice) Disconnects a source from input port
private long	midiPortConnectSource(int inputPortReference, CoreMidiSource sourceDevice) Connects a source end point to a MIDI input
private void	midiPortDisconnectSource(int inputPortReference, long memoryReference, CoreMidiSource sourceDevice) Disconnects a source end point to a MIDI input

Methods inherited from class java.lang.Object

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

Field Detail

midiPortReference

private final int midiPortReference

The OSX MIDI port reference

memoryHandle

private long memoryHandle

For each connection to an OSX EndPoint, some data is allocated on the native side. This handle tracks the allocation so that it can be returned when this port is disconnected

Constructor Detail

CoreMidiInputPort

public CoreMidiInputPort(int clientReference,
                         String portName)
                  throws CoreMidiException

Constructor

Parameters:

clientReference - The client reference

portName - The name of the input port

Throws:

CoreMidiException - if the input port cannot be created

Method Detail

connectSource

public void connectSource(CoreMidiSource sourceDevice)
                   throws CoreMidiException

Connects a source to this input port

Parameters:

sourceDevice - The source device that wishes to connect to the port

Throws:

CoreMidiException - if there is a problem establishing the connection

disconnectSource

public void disconnectSource(CoreMidiSource sourceDevice)
                      throws CoreMidiException

Disconnects a source from input port

Parameters:

sourceDevice - The source device that wishes to disconnect from the port

Throws:

CoreMidiException - if there is a problem removing the connection

createInputPort

private int createInputPort(int clientReference,
                            String portName)
                     throws CoreMidiException

Creates a CoreMIDI input port

Parameters:

clientReference - The MIDI client reference

portName - The name of the output port

Returns:

A reference to the created input port

Throws:

CoreMidiException - if the port cannot be created

midiPortConnectSource

private long midiPortConnectSource(int inputPortReference,
                                   CoreMidiSource sourceDevice)
                            throws CoreMidiException

Connects a source end point to a MIDI input

Parameters:

inputPortReference - The reference to an input port

sourceDevice - The source device that wishes to connect to the port

Returns:

A memory handle for the parameters the native side has associated with this call

Throws:

CoreMidiException - if there is a problem connecting the source

midiPortDisconnectSource

private void midiPortDisconnectSource(int inputPortReference,
                                      long memoryReference,
                                      CoreMidiSource sourceDevice)
                               throws CoreMidiException

Disconnects a source end point to a MIDI input

Parameters:

inputPortReference - The reference to an input port

memoryReference - The memory handle that can now be released.

sourceDevice - The source device that wishes to disconnect from the port

Throws:

CoreMidiException - if there is a problem disconnecting the source