Skip to content

Most visited

Recently visited

navigation

MidiDeviceInfo

public final class MidiDeviceInfo
extends Object implements Parcelable

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


This class contains information to describe a MIDI device. For now we only have information that can be retrieved easily for USB devices, but we will probably expand this in the future. This class is just an immutable object to encapsulate the MIDI device description. Use the MidiDevice class to actually communicate with devices.

Summary

Nested classes

class MidiDeviceInfo.PortInfo

Contains information about an input or output port. 

Constants

String PROPERTY_BLUETOOTH_DEVICE

Bundle key for the device's corresponding Bluetooth device.

String PROPERTY_MANUFACTURER

Bundle key for the device's manufacturer name property.

String PROPERTY_NAME

Bundle key for the device's user visible name property.

String PROPERTY_PRODUCT

Bundle key for the device's product name property.

String PROPERTY_SERIAL_NUMBER

Bundle key for the device's serial number property.

String PROPERTY_USB_DEVICE

Bundle key for the device's corresponding USB device.

String PROPERTY_VERSION

Bundle key for the device's version property.

int TYPE_BLUETOOTH

Constant representing Bluetooth MIDI devices for getType()

int TYPE_USB

Constant representing USB MIDI devices for getType()

int TYPE_VIRTUAL

Constant representing virtual (software based) MIDI devices for getType()

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<MidiDeviceInfo> CREATOR

Public methods

int describeContents()

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

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int getId()

Returns the ID of the device.

int getInputPortCount()

Returns the device's number of input ports.

int getOutputPortCount()

Returns the device's number of output ports.

PortInfo[] getPorts()

Returns information about the device's ports.

Bundle getProperties()

Returns the Bundle containing the device's properties.

int getType()

Returns the type of the device.

int hashCode()

Returns a hash code value for the object.

boolean isPrivate()

Returns true if the device is private.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

PROPERTY_BLUETOOTH_DEVICE

added in API level 23
String PROPERTY_BLUETOOTH_DEVICE

Bundle key for the device's corresponding Bluetooth device. The value for this property is of type BluetoothDevice. Only set for Bluetooth MIDI devices. Used with the Bundle returned by getProperties()

Constant Value: "bluetooth_device"

PROPERTY_MANUFACTURER

added in API level 23
String PROPERTY_MANUFACTURER

Bundle key for the device's manufacturer name property. The value for this property is of type String. Used with the Bundle returned by getProperties(). Matches the USB device manufacturer name string for USB MIDI devices.

Constant Value: "manufacturer"

PROPERTY_NAME

added in API level 23
String PROPERTY_NAME

Bundle key for the device's user visible name property. The value for this property is of type String. Used with the Bundle returned by getProperties(). For USB devices, this is a concatenation of the manufacturer and product names.

Constant Value: "name"

PROPERTY_PRODUCT

added in API level 23
String PROPERTY_PRODUCT

Bundle key for the device's product name property. The value for this property is of type String. Used with the Bundle returned by getProperties() Matches the USB device product name string for USB MIDI devices.

Constant Value: "product"

PROPERTY_SERIAL_NUMBER

added in API level 23
String PROPERTY_SERIAL_NUMBER

Bundle key for the device's serial number property. The value for this property is of type String. Used with the Bundle returned by getProperties() Matches the USB device serial number for USB MIDI devices.

Constant Value: "serial_number"

PROPERTY_USB_DEVICE

added in API level 23
String PROPERTY_USB_DEVICE

Bundle key for the device's corresponding USB device. The value for this property is of type UsbDevice. Only set for USB MIDI devices. Used with the Bundle returned by getProperties()

Constant Value: "usb_device"

PROPERTY_VERSION

added in API level 23
String PROPERTY_VERSION

Bundle key for the device's version property. The value for this property is of type String. Used with the Bundle returned by getProperties() Matches the USB device version number for USB MIDI devices.

Constant Value: "version"

TYPE_BLUETOOTH

added in API level 23
int TYPE_BLUETOOTH

Constant representing Bluetooth MIDI devices for getType()

Constant Value: 3 (0x00000003)

TYPE_USB

added in API level 23
int TYPE_USB

Constant representing USB MIDI devices for getType()

Constant Value: 1 (0x00000001)

TYPE_VIRTUAL

added in API level 23
int TYPE_VIRTUAL

Constant representing virtual (software based) MIDI devices for getType()

Constant Value: 2 (0x00000002)

Fields

CREATOR

added in API level 23
Creator<MidiDeviceInfo> CREATOR

Public methods

describeContents

added in API level 23
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.

equals

added in API level 23
boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getId

added in API level 23
int getId ()

Returns the ID of the device. This ID is generated by the MIDI service and is not persistent across device unplugs.

Returns
int the device's ID

getInputPortCount

added in API level 23
int getInputPortCount ()

Returns the device's number of input ports.

Returns
int the number of input ports

getOutputPortCount

added in API level 23
int getOutputPortCount ()

Returns the device's number of output ports.

Returns
int the number of output ports

getPorts

added in API level 23
PortInfo[] getPorts ()

Returns information about the device's ports. The ports are in unspecified order.

Returns
PortInfo[] array of MidiDeviceInfo.PortInfo

getProperties

added in API level 23
Bundle getProperties ()

Returns the Bundle containing the device's properties.

Returns
Bundle the device's properties

getType

added in API level 23
int getType ()

Returns the type of the device.

Returns
int the device's type

hashCode

added in API level 23
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isPrivate

added in API level 23
boolean isPrivate ()

Returns true if the device is private. Private devices are only visible and accessible to clients with the same UID as the application that is hosting the device.

Returns
boolean true if the device is private

toString

added in API level 23
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
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_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)