MidiDevice
public final class MidiDevice
extends Object implements Closeable
| java.lang.Object | |
| ↳ | android.media.midi.MidiDevice |
This class is used for sending and receiving data to and from a MIDI device Instances of this class are created by MidiManager.openDevice.
Summary
Nested classes | |
|---|---|
class | MidiDevice.MidiConnection This class represents a connection between the output port of one device and the input port of another. |
Public methods | |
|---|---|
void | close() Closes this stream and releases any system resources associated with it. |
MidiDevice.MidiConnection | connectPorts(MidiInputPort inputPort, int outputPortNumber) Connects the supplied |
MidiDeviceInfo | getInfo() Returns a |
MidiInputPort | openInputPort(int portNumber) Called to open a |
MidiOutputPort | openOutputPort(int portNumber) Called to open a |
String | toString() Returns a string representation of the object. |
Protected methods | |
|---|---|
void | finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
Inherited methods | |
|---|---|
Public methods
close
public void close ()
Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.
As noted in AutoCloseable.close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.
| Throws | |
|---|---|
IOException | |
connectPorts
public MidiDevice.MidiConnection connectPorts (MidiInputPort inputPort, int outputPortNumber)
Connects the supplied MidiInputPort to the output port of this device with the specified port number. Once the connection is made, the MidiInput port instance can no longer receive data via its MidiReceiver.onSend method. This method returns a MidiDevice.MidiConnection object, which can be used to close the connection.
| Parameters | |
|---|---|
inputPort | MidiInputPort: the inputPort to connect |
outputPortNumber | int: the port number of the output port to connect inputPort to. |
| Returns | |
|---|---|
MidiDevice.MidiConnection | MidiDevice.MidiConnection object if the connection is successful, or null in case of failure. |
getInfo
public MidiDeviceInfo getInfo ()
Returns a MidiDeviceInfo object, which describes this device.
| Returns | |
|---|---|
MidiDeviceInfo | the MidiDeviceInfo object |
openInputPort
public MidiInputPort openInputPort (int portNumber)
Called to open a MidiInputPort for the specified port number. An input port can only be used by one sender at a time. Opening an input port will fail if another application has already opened it for use. A MidiDeviceStatus can be used to determine if an input port is already open.
| Parameters | |
|---|---|
portNumber | int: the number of the input port to open |
| Returns | |
|---|---|
MidiInputPort | the MidiInputPort if the open is successful, or null in case of failure. |
openOutputPort
public MidiOutputPort openOutputPort (int portNumber)
Called to open a MidiOutputPort for the specified port number. An output port may be opened by multiple applications.
| Parameters | |
|---|---|
portNumber | int: the number of the output port to open |
| Returns | |
|---|---|
MidiOutputPort | the MidiOutputPort if the open is successful, or null in case of failure. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String | a string representation of the object. |
Protected methods
finalize
protected void finalize ()
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
The finalize method is never invoked more than once by a Java virtual machine for any given object.
Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
| Throws | |
|---|---|
Throwable | |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.