Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

MidiDeviceStatus

public final class MidiDeviceStatus
extends Object implements Parcelable

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


This is an immutable class that describes the current status of a MIDI device's ports.

Summary

Inherited constants

Fields

public static final Creator<MidiDeviceStatus> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

MidiDeviceInfo getDeviceInfo()

Returns the MidiDeviceInfo of the device.

int getOutputPortOpenCount(int portNumber)

Returns the number of clients currently connected to the specified output port.

boolean isInputPortOpen(int portNumber)

Returns true if an input port is open.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 23
public static final Creator<MidiDeviceStatus> CREATOR

Public methods

describeContents

added in API level 23
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getDeviceInfo

added in API level 23
public MidiDeviceInfo getDeviceInfo ()

Returns the MidiDeviceInfo of the device.

Returns
MidiDeviceInfo the device info

getOutputPortOpenCount

added in API level 23
public int getOutputPortOpenCount (int portNumber)

Returns the number of clients currently connected to the specified output port. Unlike input ports, an output port can be opened by multiple clients at the same time.

Parameters
portNumber int: the output port's port number

Returns
int output port open count

isInputPortOpen

added in API level 23
public boolean isInputPortOpen (int portNumber)

Returns true if an input port is open. An input port can only be opened by one client at a time.

Parameters
portNumber int: the input port's port number

Returns
boolean input port open status

toString

added in API level 23
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 23
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.