javax.sound.midi

Interface MidiDevice

All Superinterfaces:
AutoCloseable
Known Subinterfaces:
Sequencer, Synthesizer

public interface MidiDevice
extends AutoCloseable

Interface for all MIDI devices.
Since:
1.3

Nested Class Summary

static class
MidiDevice.Info
A MIDI device descriptor object.

Method Summary

void
close()
Close this MIDI device, and release any system resources we're using.
MidiDevice.Info
getDeviceInfo()
Get the Info object describing this device.
int
getMaxReceivers()
The maximum number of MIDI IN connections we can get as Receivers, or -1 if there is no maximum.
int
getMaxTransmitters()
The maximum number of MIDI OUT connections we can get as Transmitters, or -1 if there is no maximum.
long
getMicrosecondPosition()
If this device supports time-stamps, then it will return the number of microseconds since this device has been open, and -1 otherwise.
Receiver
getReceiver()
Get a MIDI IN Receiver for this device.
Transmitter
getTransmitter()
Get a MIDI OUT Transmitter for this device.
boolean
isOpen()
Returns true if this MIDI device is open and false otherwise.
void
open()
Open this MIDI device and allocate any system resource we need.

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

close

public void close()
Close this MIDI device, and release any system resources we're using.
Specified by:
close in interface AutoCloseable

getDeviceInfo

public MidiDevice.Info getDeviceInfo()
Get the Info object describing this device.
Returns:
the Info object describing this device

getMaxReceivers

public int getMaxReceivers()
The maximum number of MIDI IN connections we can get as Receivers, or -1 if there is no maximum.
Returns:
-1 or the maximum number of Receivers we can get

getMaxTransmitters

public int getMaxTransmitters()
The maximum number of MIDI OUT connections we can get as Transmitters, or -1 if there is no maximum.
Returns:
-1 or the maximum number of Transmitters we can get

getMicrosecondPosition

public long getMicrosecondPosition()
If this device supports time-stamps, then it will return the number of microseconds since this device has been open, and -1 otherwise.
Returns:
-1 or the number of microseconds since this was opened

getReceiver

public Receiver getReceiver()
            throws MidiUnavailableException
Get a MIDI IN Receiver for this device.
Returns:
a MIDI IN Receiver for this device
Throws:
MidiUnavailableException - if we can't get a Receiver

getTransmitter

public Transmitter getTransmitter()
            throws MidiUnavailableException
Get a MIDI OUT Transmitter for this device.
Returns:
a MIDI OUT Transmitter for this device
Throws:
MidiUnavailableException - if we can't get a Transmitter

isOpen

public boolean isOpen()
Returns true if this MIDI device is open and false otherwise.
Returns:
true if this is open, false otherwise

open

public void open()
            throws MidiUnavailableException
Open this MIDI device and allocate any system resource we need.
Throws:
MidiUnavailableException - if we're not able to open for some reason

MidiDevice.java -- Interface for MIDI devices Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.