uk.co.xfactorylibrarians.coremidi4j

Class CoreMidiOutputPort

java.lang.Object

uk.co.xfactorylibrarians.coremidi4j.CoreMidiOutputPort

public class CoreMidiOutputPort
extends Object

CoreMidiOutputPort

Field Summary

Fields

Modifier and Type	Field and Description
private int	midiPortReference

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private int	createOutputPort(int clientReference, String portName) Creates a CoreMIDI output port
void	send(int destinationEndPointReference, MidiMessage message, long timestamp) Sends a MIDI message on this output port to the specified destination end point
private void	sendMidiMessage(int midiPortReference, int destinationEndPointReference, MidiMessage message, long timestamp) Transmits a MIDI message to the OSX CoreMidi device

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

Constructor Detail

CoreMidiOutputPort

public CoreMidiOutputPort(int clientReference,
                          String portName)
                   throws CoreMidiException

Constructor

Parameters:

clientReference - The client reference

portName - The name of the port

Throws:

CoreMidiException - if there is a problem creating the port

Method Detail

send

public void send(int destinationEndPointReference,
                 MidiMessage message,
                 long timestamp)
          throws CoreMidiException

Sends a MIDI message on this output port to the specified destination end point

Parameters:

destinationEndPointReference - The destination end point to send the message to

message - The message to send

timestamp - The time at which the message should take effect, in microseconds since the system booted, with 0 meaning "immediately".

Throws:

CoreMidiException - if there is a problem sending the message

createOutputPort

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

Creates a CoreMIDI output port

Javah converts the Java function call to a C funtion call using the signature JNIEXPORT jint JNICALL Java_uk_co_xfactorylibrarians_coremidi4j_CoreMidiOutputPort_createOutputPort (JNIEnv *, jobject, jint, jstring);

Parameters:

clientReference - The MIDI client reference

portName - The name of the output port

Returns:

A reference to the created output port

Throws:

CoreMidiException - if the port cannot be created

sendMidiMessage

private void sendMidiMessage(int midiPortReference,
                             int destinationEndPointReference,
                             MidiMessage message,
                             long timestamp)
                      throws CoreMidiException

Transmits a MIDI message to the OSX CoreMidi device

Javah converts the Java method call to a C function call using the signature. JNIEXPORT void JNICALL Java_uk_co_xfactorylibrarians_coremidi4j_CoreMidiOutputPort_sendMidiMessage (JNIEnv *, jobject, jint, jint, jobject, jlong);. See CoreMidiOutputPort.cpp

Parameters:

midiPortReference - The output MIDI port reference

destinationEndPointReference - The device to send the message to

message - The message to send

timestamp - The time at which the message should take effect, in microseconds since the system booted, with zero meaning immediately.

Throws:

CoreMidiException - if there is a problem sending the message