MIDIPort
Defined in: src/MIDIPort.ts:8
Base interface for a single MIDI input or output port.
Mirrors the Web MIDI API MIDIPort.
Extends
Section titled “Extends”MIDIEventTarget
Extended by
Section titled “Extended by”Properties
Section titled “Properties”connection
Section titled “connection”
readonlyconnection:"open"|"closed"|"pending"
Defined in: src/MIDIPort.ts:23
The port’s connection state.
readonlyid:string
Defined in: src/MIDIPort.ts:10
A unique, stable id for this port.
manufacturer
Section titled “manufacturer”
readonlymanufacturer:string
Defined in: src/MIDIPort.ts:12
The manufacturer of the port, if known.
readonlyname:string
Defined in: src/MIDIPort.ts:14
The display name of the port.
onstatechange
Section titled “onstatechange”onstatechange: ((
e) =>void) |null
Defined in: src/MIDIPort.ts:31
Handler invoked when the port’s state changes.
readonlystate:"connected"|"disconnected"
Defined in: src/MIDIPort.ts:21
Whether the underlying device is "connected" or "disconnected".
readonlytype:"input"|"output"
Defined in: src/MIDIPort.ts:16
Whether this is an "input" or "output" port.
version
Section titled “version”
readonlyversion:string
Defined in: src/MIDIPort.ts:18
The version of the port, if known.
Methods
Section titled “Methods”addEventListener()
Section titled “addEventListener()”Call Signature
Section titled “Call Signature”addEventListener(
type,listener,options?):void
Defined in: src/MIDIPort.ts:33
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”MIDIEventTarget.addEventListener
Call Signature
Section titled “Call Signature”addEventListener(
type,listener,options?):void
Defined in: src/MIDIPort.ts:38
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”MIDIEventTarget.addEventListener
close()
Section titled “close()”close():
Promise<void>
Defined in: src/MIDIPort.ts:28
Close the port.
Returns
Section titled “Returns”Promise<void>
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”MIDIEventTarget.dispatchEvent
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>
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
Inherited from
Section titled “Inherited from”MIDIEventTarget.removeEventListener