Added in API level 23

Summary: Nested Classes | Methods | Protected Methods | Inherited Methods

MidiDevice

---

Kotlin |Java

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 MidiInputPort to the output port of this device with the specified port number.
MidiDeviceInfo	getInfo() Returns a MidiDeviceInfo object, which describes this device.
MidiInputPort	openInputPort(int portNumber) Called to open a MidiInputPort for the specified port number.
MidiOutputPort	openOutputPort(int portNumber) Called to open a MidiOutputPort for the specified port number.
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
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface java.io.Closeable abstract void close() Closes this stream and releases any system resources associated with it.
From interface java.lang.AutoCloseable abstract void close() Closes this resource, relinquishing any underlying resources.

Public methods

close

Added in API level 23

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

Added in API level 23

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

Added in API level 23

public MidiDeviceInfo getInfo ()

Returns a MidiDeviceInfo object, which describes this device.

Returns
MidiDeviceInfo	the MidiDeviceInfo object

openInputPort

Added in API level 23

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

Added in API level 23

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

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

Protected methods

finalize

Added in API level 23

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