MIDIPort

The MIDIPort interface of the Web MIDI API represents a MIDI input or output port. Available only in secure contexts.

MDN Reference

Extends

• EventTarget

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Type Parameters

Type Parameter
K extends "statechange"

Parameters

Parameter	Type
type	K
listener	(this, ev) => any
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Call Signature

addEventListener(
   type, 
   listener, 
   options?
): void;

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

---

close()

close(): Promise<MIDIPort>;

The close() method of the MIDIPort interface makes the access to the MIDI device connected to this MIDIPort unavailable.

MDN Reference

Returns

Promise<MIDIPort>

---

dispatchEvent()

dispatchEvent(event): boolean;

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

---

open()

open(): Promise<MIDIPort>;

The open() method of the MIDIPort interface makes the MIDI device connected to this MIDIPort explicitly available.

MDN Reference

Returns

Promise<MIDIPort>

---

removeEventListener()

Call Signature

removeEventListener<K>(
   type, 
   listener, 
   options?
): void;

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference

Type Parameters

Type Parameter
K extends "statechange"

Parameters

Parameter	Type
type	K
listener	(this, ev) => any
options?	boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Call Signature

removeEventListener(
   type, 
   listener, 
   options?
): void;

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Properties

connection

readonly connection: MIDIPortConnectionState;

The connection read-only property of the MIDIPort interface returns the connection state of the port.

MDN Reference

---

id

readonly id: string;

The id read-only property of the MIDIPort interface returns the unique ID of the port.

MDN Reference

---

manufacturer

readonly manufacturer: string | null;

The manufacturer read-only property of the MIDIPort interface returns the manufacturer of the port.

MDN Reference

---

name

readonly name: string | null;

The name read-only property of the MIDIPort interface returns the system name of the port.

MDN Reference

---

onstatechange

onstatechange: ((this, ev) => any) | null;

MDN Reference

---

state

readonly state: MIDIPortDeviceState;

The state read-only property of the MIDIPort interface returns the state of the port.

MDN Reference

---

type

readonly type: MIDIPortType;

The type read-only property of the MIDIPort interface returns the type of the port, indicating whether this is an input or output MIDI port.

MDN Reference

---

version

readonly version: string | null;

The version read-only property of the MIDIPort interface returns the version of the port.

MDN Reference