MidiService (jsynthlib 1.1-SNAPSHOT API)

All Known Implementing Classes:

MidiServiceImpl
```
public interface MidiService
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`SysexMessage[]`	`byteArrayToSysexMessages(byte[] d)` Converts a byte array into an array of SysexMessages.
`void`	`clearSysexInputQueue(int port)` clear MIDI input queue specified.
`void`	`closeAllMidiConnections()`
`MidiMessage`	`getMessage(int port, long timeout)` get Sysex Message from MIDI input queue.
`Receiver`	`getReceiver(String portName)`
`Transmitter`	`getTransmitter(String portName)`
`boolean`	`isSysexInputQueueEmpty(int port)` return `true` when MIDI input queue is empty.
`void`	`releaseReceiver(Receiver receiver)`
`void`	`releaseTransmitter(Transmitter transmitter)`
`void`	`send(String outPortName, MidiMessage msg, int bufSize, int delay)` Send a `MidiMessage`.
`void`	`setSysexInputQueue(int port)` Setup an input queue for MIDI System Exclusive Message input.
`void`	`startSequencer(String portName)` Maybe these methods should be in an own class, but currently I put them here.
`byte[]`	`sysexMessagesToByteArray(SysexMessage[] msgs)` Convert an array of SysexMessage to a byte array.

- Method Detail
  - setSysexInputQueue
```
void setSysexInputQueue(int port)
```
    Setup an input queue for MIDI System Exclusive Message input. The input queue is shared. If the input queue is already opened, nothing is done.
    
    See Also:
    
    clearSysexInputQueue(int)
  - clearSysexInputQueue
```
void clearSysexInputQueue(int port)
```
    clear MIDI input queue specified. Internally setSysexInputQueue(port) is called.
    
    See Also:
    
    setSysexInputQueue(int)
  - isSysexInputQueueEmpty
```
boolean isSysexInputQueueEmpty(int port)
```
    return true when MIDI input queue is empty.
    
    See Also:
    
    clearSysexInputQueue(int)
  - getMessage
```
MidiMessage getMessage(int port,
                       long timeout)
                throws TimeoutException,
                       InvalidMidiDataException
```
    get Sysex Message from MIDI input queue.
    
    Throws:
    
    TimeoutException
    
    InvalidMidiDataException
    
    See Also:
    
    clearSysexInputQueue(int)
  - byteArrayToSysexMessages
```
SysexMessage[] byteArrayToSysexMessages(byte[] d)
                                 throws InvalidMidiDataException
```
    Converts a byte array into an array of SysexMessages. Each SysexMessage must be terminated by END_OF_EXCLUSIVE.
    This method is provided to keep compatibility with the old MIDI layer which handled MIDI data in byte array. It is more efficient to create SysexMessages directly because a synth driver knows the start index and length of each Sysex data in an array.
    
    Throws:
    
    InvalidMidiDataException
  - sysexMessagesToByteArray
```
byte[] sysexMessagesToByteArray(SysexMessage[] msgs)
```
    Convert an array of SysexMessage to a byte array.
    
    Parameters:
    
    msgs - an array of SysexMessage.
    
    Returns:
    
    byte array of System Exclusive data.
  - send
```
void send(String outPortName,
          MidiMessage msg,
          int bufSize,
          int delay)
   throws MidiUnavailableException,
          InvalidMidiDataException
```
    Send a MidiMessage. A Sysex Message is divided into several Sysex Messages whose size is bufSize.
    
    Parameters:
    
    outPortName - MIDI out port name
    
    msg - MIDI Message
    
    bufSize - MIDI message size. If zero, whole MIDI message is passed to lower MIDI driver.
    
    delay - delay (msec) after every MIDI message transfer.
    
    Throws:
    
    MidiUnavailableException
    
    InvalidMidiDataException
  - startSequencer
```
void startSequencer(String portName)
```
    Maybe these methods should be in an own class, but currently I put them here. ttittmann 01.Aug.2004
  - getReceiver
```
Receiver getReceiver(String portName)
              throws MidiUnavailableException
```
    Throws:
    
    MidiUnavailableException
  - releaseReceiver
```
void releaseReceiver(Receiver receiver)
              throws MidiUnavailableException
```
    Throws:
    
    MidiUnavailableException
  - getTransmitter
```
Transmitter getTransmitter(String portName)
                    throws MidiUnavailableException
```
    Throws:
    
    MidiUnavailableException
  - releaseTransmitter
```
void releaseTransmitter(Transmitter transmitter)
                 throws MidiUnavailableException
```
    Throws:
    
    MidiUnavailableException
  - closeAllMidiConnections
```
void closeAllMidiConnections()
```

Interface MidiService

Method Summary

Method Detail

setSysexInputQueue

clearSysexInputQueue

isSysexInputQueueEmpty

getMessage

byteArrayToSysexMessages

sysexMessagesToByteArray

send

startSequencer

getReceiver

releaseReceiver

getTransmitter

releaseTransmitter

closeAllMidiConnections