MIDIInput
Defined in: src/MIDIInput.ts:9
A MIDI input port — a source of inbound MIDI messages.
Mirrors the Web MIDI API MIDIInput.
Extends
Section titled “Extends”Properties
Section titled “Properties”connection
Section titled “connection”
readonlyconnection:"open"|"closed"|"pending"
Defined in: src/MIDIPort.ts:23
The port’s connection state.
Inherited from
Section titled “Inherited from”
readonlyid:string
Defined in: src/MIDIPort.ts:10
A unique, stable id for this port.
Inherited from
Section titled “Inherited from”manufacturer
Section titled “manufacturer”
readonlymanufacturer:string
Defined in: src/MIDIPort.ts:12
The manufacturer of the port, if known.
Inherited from
Section titled “Inherited from”
readonlyname:string
Defined in: src/MIDIPort.ts:14
The display name of the port.
Inherited from
Section titled “Inherited from”onmidimessage
Section titled “onmidimessage”onmidimessage: ((
e) =>void) |null
Defined in: src/MIDIInput.ts:13
Handler invoked for every complete inbound MIDI message.
onstatechange
Section titled “onstatechange”onstatechange: ((
e) =>void) |null
Defined in: src/MIDIPort.ts:31
Handler invoked when the port’s state changes.
Inherited from
Section titled “Inherited from”
readonlystate:"connected"|"disconnected"
Defined in: src/MIDIPort.ts:21
Whether the underlying device is "connected" or "disconnected".
Inherited from
Section titled “Inherited from”
readonlytype:"input"
Defined in: src/MIDIInput.ts:10
Whether this is an "input" or "output" port.
Overrides
Section titled “Overrides”version
Section titled “version”
readonlyversion:string
Defined in: src/MIDIPort.ts:18
The version of the port, if known.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addEventListener()
Section titled “addEventListener()”Call Signature
Section titled “Call Signature”addEventListener(
type,listener,options?):void
Defined in: src/MIDIInput.ts:15
Parameters
Section titled “Parameters”"midimessage"
listener
Section titled “listener”(this, e) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”Call Signature
Section titled “Call Signature”addEventListener(
type,listener,options?):void
Defined in: src/MIDIInput.ts:21
Parameters
Section titled “Parameters”"statechange"
listener
Section titled “listener”(this, e) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”Call Signature
Section titled “Call Signature”addEventListener(
type,listener,options?):void
Defined in: src/MIDIInput.ts:26
Parameters
Section titled “Parameters”string
listener
Section titled “listener”EventListenerOrEventListenerObject
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”MIDIPort.addEventListener
close()
Section titled “close()”close():
Promise<void>
Defined in: src/MIDIPort.ts:28
Close the port.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”dispatchEvent()
Section titled “dispatchEvent()”dispatchEvent(
event):boolean
Defined in: src/MIDIEventTarget.ts:23
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”open()
Section titled “open()”open():
Promise<void>
Defined in: src/MIDIPort.ts:26
Open the port, resolving when it is ready for I/O.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”removeEventListener()
Section titled “removeEventListener()”removeEventListener(
type,listener,options?):void
Defined in: src/MIDIEventTarget.ts:18
Parameters
Section titled “Parameters”string
listener
Section titled “listener”EventListenerOrEventListenerObject
options?
Section titled “options?”boolean | EventListenerOptions
Returns
Section titled “Returns”void