Added in API level 23

Summary: Ctors | Methods | Inherited Methods

MidiReceiver

Kotlin |Java

public abstract class MidiReceiver
extends Object

java.lang.Object
↳	android.media.midi.MidiReceiver

Known direct subclasses

MidiInputPort

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

Interface for sending and receiving data to and from a MIDI device.

Summary

Public constructors
`MidiReceiver()` Default MidiReceiver constructor.
`MidiReceiver(int maxMessageSize)` MidiReceiver constructor.

Public methods
`void`	`flush()` Instructs the receiver to discard all pending MIDI data.
`final int`	`getMaxMessageSize()` Returns the maximum size of a message this receiver can receive.
`void`	`onFlush()` Called when the receiver is instructed to discard all pending MIDI data.
`abstract void`	`onSend(byte[] msg, int offset, int count, long timestamp)` Called whenever the receiver is passed new MIDI data.
`void`	`send(byte[] msg, int offset, int count)` Called to send MIDI data to the receiver without a timestamp.
`void`	`send(byte[] msg, int offset, int count, long timestamp)` Called to send MIDI data to the receiver with a specified timestamp.

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.

Public constructors

MidiReceiver

Added in API level 23

public MidiReceiver ()

Default MidiReceiver constructor. Maximum message size is set to Integer.MAX_VALUE

MidiReceiver

Added in API level 23

public MidiReceiver (int maxMessageSize)

MidiReceiver constructor.

Parameters
`maxMessageSize`	`int`: the maximum size of a message this receiver can receive

Public methods

flush

Added in API level 23

public void flush ()

Instructs the receiver to discard all pending MIDI data.

Throws
	java.io.IOException
`IOException`

getMaxMessageSize

Added in API level 23

public final int getMaxMessageSize ()

Returns the maximum size of a message this receiver can receive.

Returns
`int`	maximum message size

onFlush

Added in API level 23

public void onFlush ()

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
	java.io.IOException
`IOException`

onSend

Added in API level 23

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

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`	`byte`: a byte array containing the MIDI data
`offset`	`int`: the offset of the first byte of the data in the array to be processed
`count`	`int`: the number of bytes of MIDI data in the array to be processed
`timestamp`	`long`: the timestamp of the message (based on `System.nanoTime()`

Throws
	java.io.IOException
`IOException`

send

Added in API level 23

public void send (byte[] msg, 
                int offset, 
                int count)

Called to send MIDI data to the receiver without a timestamp. Data will be processed by receiver in the order sent. Data will get split into multiple calls to onSend(byte, int, int, long) if count exceeds getMaxMessageSize(). Blocks until all the data is sent or an exception occurs. In the latter case, the amount of data sent prior to the exception is not provided to caller. The communication should be considered corrupt. The sender should reestablish communication, reset all controllers and send all notes off.

Parameters
`msg`	`byte`: a byte array containing the MIDI data
`offset`	`int`: the offset of the first byte of the data in the array to be sent
`count`	`int`: the number of bytes of MIDI data in the array to be sent

Throws
`IOException`	if the data could not be sent in entirety

send

Added in API level 23

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

Called to send MIDI data to the receiver with a specified timestamp. Data will be processed by receiver in order first by timestamp, then in the order sent. Data will get split into multiple calls to onSend(byte, int, int, long) if count exceeds getMaxMessageSize(). Blocks until all the data is sent or an exception occurs. In the latter case, the amount of data sent prior to the exception is not provided to caller. The communication should be considered corrupt. The sender should reestablish communication, reset all controllers and send all notes off.

Parameters
`msg`	`byte`: a byte array containing the MIDI data
`offset`	`int`: the offset of the first byte of the data in the array to be sent
`count`	`int`: the number of bytes of MIDI data in the array to be sent
`timestamp`	`long`: the timestamp of the message, based on `System.nanoTime()`

Throws
`IOException`	if the data could not be sent in entirety