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 |
int |
TYPE_USB
Constant representing USB MIDI devices for |
int |
TYPE_VIRTUAL
Constant representing virtual (software based) MIDI devices for |
Inherited constants |
---|
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 |
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 | |
---|---|
Constants
PROPERTY_BLUETOOTH_DEVICE
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
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
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
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
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
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
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
int TYPE_BLUETOOTH
Constant representing Bluetooth MIDI devices for getType()
Constant Value: 3 (0x00000003)
TYPE_USB
int TYPE_USB
Constant representing USB MIDI devices for getType()
Constant Value: 1 (0x00000001)
TYPE_VIRTUAL
int TYPE_VIRTUAL
Constant representing virtual (software based) MIDI devices for getType()
Constant Value: 2 (0x00000002)
Fields
Public methods
describeContents
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
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
int getInputPortCount ()
Returns the device's number of input ports.
Returns | |
---|---|
int |
the number of input ports |
getOutputPortCount
int getOutputPortCount ()
Returns the device's number of output ports.
Returns | |
---|---|
int |
the number of output ports |
getPorts
PortInfo[] getPorts ()
Returns information about the device's ports. The ports are in unspecified order.
Returns | |
---|---|
PortInfo[] |
array of MidiDeviceInfo.PortInfo
|
getProperties
Bundle getProperties ()
Returns the Bundle
containing the device's properties.
Returns | |
---|---|
Bundle |
the device's properties |
getType
int getType ()
Returns the type of the device.
Returns | |
---|---|
int |
the device's type |
hashCode
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 inequals
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 thehashCode
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 thehashCode
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
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
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
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 .
|