Interface MIDIPort

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

MDN Reference

interface MIDIPort {
    connection: MIDIPortConnectionState;
    id: string;
    manufacturer: string | null;
    name: string | null;
    onstatechange: ((this: MIDIPort, ev: MIDIConnectionEvent) => any) | null;
    state: MIDIPortDeviceState;
    type: MIDIPortType;
    version: string | null;
    addEventListener<K extends "statechange">(
        type: K,
        listener: (this: MIDIPort, ev: MIDIPortEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    close(): Promise<MIDIPort>;
    dispatchEvent(event: Event): boolean;
    open(): Promise<MIDIPort>;
    removeEventListener<K extends "statechange">(
        type: K,
        listener: (this: MIDIPort, ev: MIDIPortEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
}
Hierarchy
  • EventTarget
    • MIDIPort
Index

Properties

connection id manufacturer name onstatechange state type version

Methods

addEventListener close dispatchEvent open removeEventListener

Properties

connection: MIDIPortConnectionState

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

MDN Reference

id: string

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

MDN Reference

manufacturer: string | null

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

MDN Reference

name: string | null

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

MDN Reference

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

MDN Reference

state: MIDIPortDeviceState

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

MDN Reference

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: string | null

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

MDN Reference

Methods

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

    MDN Reference

    Returns Promise<MIDIPort>

  • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

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

    MDN Reference

    Returns Promise<MIDIPort>

  • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

    MDN Reference

    Type Parameters

    • K extends "statechange"

    Parameters

    Returns void

  • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

    MDN Reference

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods