AutoCloseable
Sequencer
, Synthesizer
public interface MidiDevice extends AutoCloseable
MidiDevice
is the base interface for all MIDI devices. Common devices include synthesizers, sequencers, MIDI input ports, and MIDI output ports. A MidiDevice
can be a transmitter or a receiver of MIDI events, or both. Therefore, it can provide Transmitter
or Receiver
instances (or both). Typically, MIDI IN ports provide transmitters, MIDI OUT ports and synthesizers provide receivers. A Sequencer typically provides transmitters for playback and receivers for recording.
A MidiDevice
can be opened and closed explicitly as well as implicitly. Explicit opening is accomplished by calling open()
, explicit closing is done by calling close()
on the MidiDevice
instance. If an application opens a MidiDevice
explicitly, it has to close it explicitly to free system resources and enable the application to exit cleanly. Implicit opening is done by calling MidiSystem.getReceiver()
and MidiSystem.getTransmitter()
. The MidiDevice
used by MidiSystem.getReceiver
and MidiSystem.getTransmitter
is implementation-dependent unless the properties javax.sound.midi.Receiver
and javax.sound.midi.Transmitter
are used (see the description of properties to select default providers in MidiSystem
). A MidiDevice
that was opened implicitly, is closed implicitly by closing the Receiver
or Transmitter
that resulted in opening it. If more than one implicitly opening Receiver
or Transmitter
were obtained by the application, the device is closed after the last Receiver
or Transmitter
has been closed. On the other hand, calling getReceiver
or getTransmitter
on the device instance directly does not open the device implicitly. Closing these Transmitter
s and Receiver
s does not close the device implicitly. To use a device with Receiver
s or Transmitter
s obtained this way, the device has to be opened and closed explicitly.
If implicit and explicit opening and closing are mixed on the same MidiDevice
instance, the following rules apply:
MidiDevice device = ...;
if (!(device instanceof Sequencer) && !(device instanceof Synthesizer)) {
// we're now sure that device represents a MIDI port
// ...
}
A MidiDevice
includes a MidiDevice.Info
object to provide manufacturer information and so on.
Modifier and Type | Interface | Description |
---|---|---|
static class |
MidiDevice.Info |
A MidiDevice.Info object contains assorted data about a MidiDevice , including its name, the company who created it, and descriptive text. |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes the device, indicating that the device should now release any system resources it is using. |
MidiDevice.Info |
getDeviceInfo() |
Obtains information about the device, including its Java class and Strings containing its name, vendor, and description. |
int |
getMaxReceivers() |
Obtains the maximum number of MIDI IN connections available on this MIDI device for receiving MIDI data. |
int |
getMaxTransmitters() |
Obtains the maximum number of MIDI OUT connections available on this MIDI device for transmitting MIDI data. |
long |
getMicrosecondPosition() |
Obtains the current time-stamp of the device, in microseconds. |
Receiver |
getReceiver() |
Obtains a MIDI IN receiver through which the MIDI device may receive MIDI data. |
List |
getReceivers() |
Returns all currently active, non-closed receivers connected with this MidiDevice . |
Transmitter |
getTransmitter() |
Obtains a MIDI OUT connection from which the MIDI device will transmit MIDI data. |
List |
getTransmitters() |
Returns all currently active, non-closed transmitters connected with this MidiDevice . |
boolean |
isOpen() |
Reports whether the device is open. |
void |
open() |
Opens the device, indicating that it should now acquire any system resources it requires and become operational. |
MidiDevice.Info getDeviceInfo()
Strings
containing its name, vendor, and description.void open() throws MidiUnavailableException
An application opening a device explicitly with this call has to close the device by calling close()
. This is necessary to release system resources and allow applications to exit cleanly.
Note that some devices, once closed, cannot be reopened. Attempts to reopen such a device will always result in a MidiUnavailableException
.
MidiUnavailableException
- thrown if the device cannot be opened due to resource restrictionsSecurityException
- thrown if the device cannot be opened due to security restrictionsvoid close()
All Receiver
and Transmitter
instances open from this device are closed. This includes instances retrieved via MidiSystem
.
close
in interface AutoCloseable
boolean isOpen()
true
if the device is open, otherwise false
long getMicrosecondPosition()
int getMaxReceivers()
int getMaxTransmitters()
Receiver getReceiver() throws MidiUnavailableException
Usually the returned receiver implements the MidiDeviceReceiver
interface.
Obtaining a Receiver
with this method does not open the device. To be able to use the device, it has to be opened explicitly by calling open()
. Also, closing the Receiver
does not close the device. It has to be closed explicitly by calling close()
.
MidiUnavailableException
- thrown if a receiver is not available due to resource restrictionsList<Receiver> getReceivers()
MidiDevice
. A receiver can be removed from the device by closing it. Usually the returned receivers implement the MidiDeviceReceiver
interface.
Transmitter getTransmitter() throws MidiUnavailableException
Usually the returned transmitter implements the MidiDeviceTransmitter
interface.
Obtaining a Transmitter
with this method does not open the device. To be able to use the device, it has to be opened explicitly by calling open()
. Also, closing the Transmitter
does not close the device. It has to be closed explicitly by calling close()
.
MidiUnavailableException
- thrown if a transmitter is not available due to resource restrictionsList<Transmitter> getTransmitters()
MidiDevice
. A transmitter can be removed from the device by closing it. Usually the returned transmitters implement the MidiDeviceTransmitter
interface.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/sound/midi/MidiDevice.html