MidiDeviceStatus

Kotlin |Java

class MidiDeviceStatus : Parcelable

kotlin.Any
↳	android.media.midi.MidiDeviceStatus

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

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

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(portNumber: Int)` Returns the number of clients currently connected to the specified output port.
Boolean	`isInputPortOpen(portNumber: Int)` Returns true if an input port is open.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(parcel: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<MidiDeviceStatus!>	`CREATOR`

Public methods

describeContents

Added in API level 23

fun describeContents(): Int

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(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getDeviceInfo

Added in API level 23

fun getDeviceInfo(): MidiDeviceInfo!

Returns the MidiDeviceInfo of the device.

Return
`MidiDeviceInfo!`	the device info

getOutputPortOpenCount

Added in API level 23

fun getOutputPortOpenCount(portNumber: Int): Int

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

Return
`Int`	output port open count

isInputPortOpen

Added in API level 23

fun isInputPortOpen(portNumber: Int): Boolean

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

Return
`Boolean`	input port open status

toString

Added in API level 23

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 23

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<MidiDeviceStatus!>