Android APIs
public final class

MidiInputPort

extends MidiReceiver
implements Closeable
java.lang.Object
   ↳ android.media.midi.MidiReceiver
     ↳ android.media.midi.MidiInputPort

Class Overview

This class is used for sending data to a port on a MIDI device

Summary

Public Methods
void close()
Closes the object and release any system resources it holds.
final int getPortNumber()
Returns the port number of this port
void onFlush()
Called when the receiver is instructed to discard all pending MIDI data.
void onSend(byte[] msg, int offset, int count, long timestamp)
Called whenever the receiver is passed new MIDI data.
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class android.media.midi.MidiReceiver
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public Methods

public void close ()

Added in API level 23

Closes the object and release any system resources it holds.

Although only the first call has any effect, it is safe to call close multiple times on the same object. This is more lenient than the overridden AutoCloseable.close(), which may be called at most once.

Throws
IOException

public final int getPortNumber ()

Added in API level 23

Returns the port number of this port

Returns
  • the port's port number

public void onFlush ()

Added in API level 23

Called when the receiver is instructed to discard all pending MIDI data. Subclasses should override this method if they maintain a list or queue of MIDI data to be processed in the future.

Throws
IOException

public void onSend (byte[] msg, int offset, int count, long timestamp)

Added in API level 23

Called whenever the receiver is passed new MIDI data. Subclasses override this method to receive MIDI data. May fail if count exceeds getMaxMessageSize(). NOTE: the msg array parameter is only valid within the context of this call. The msg bytes should be copied by the receiver rather than retaining a reference to this parameter. Also, modifying the contents of the msg array parameter may result in other receivers in the same application receiving incorrect values in their {link #onSend} method.

Parameters
msg a byte array containing the MIDI data
offset the offset of the first byte of the data in the array to be processed
count the number of bytes of MIDI data in the array to be processed
timestamp the timestamp of the message (based on nanoTime()
Throws
IOException

Protected Methods

protected void finalize ()

Added in API level 23

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable