Search

Search something to see results

GitHub

MIDIInput

Available only in secure contexts.

MDN Reference

interface MIDIInput {
    charging?: boolean;
    chargingTime?: number;
    dischargingTime?: number;
    level?: number;
    dispatchEvent(event: Event): boolean;
    onmidimessage: null | ((this: MIDIInput, ev: MIDIMessageEvent) => any);
    addEventListener<K extends keyof MIDIInputEventMap>(
        type: K,
        listener: (this: MIDIInput, ev: MIDIInputEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    removeEventListener<K extends keyof MIDIInputEventMap>(
        type: K,
        listener: (this: MIDIInput, ev: MIDIInputEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    connection: MIDIPortConnectionState;
    id: string;
    manufacturer: null | string;
    name: null | string;
    onstatechange: null | ((this: MIDIPort, ev: MIDIConnectionEvent) => any);
    state: MIDIPortDeviceState;
    type: MIDIPortType;
    version: null | string;
    close(): Promise<MIDIPort>;
    open(): Promise<MIDIPort>;
}

Hierarchy (View Summary)

Index

Properties

<internal>.MIDIInput.charging<internal>.MIDIInput.chargingTime<internal>.MIDIInput.dischargingTime<internal>.MIDIInput.level<internal>.MIDIInput.onmidimessage<internal>.MIDIInput.connection<internal>.MIDIInput.id<internal>.MIDIInput.manufacturer<internal>.MIDIInput.name<internal>.MIDIInput.onstatechange<internal>.MIDIInput.state<internal>.MIDIInput.type<internal>.MIDIInput.version

Methods

<internal>.MIDIInput.dispatchEvent<internal>.MIDIInput.addEventListener<internal>.MIDIInput.removeEventListener<internal>.MIDIInput.close<internal>.MIDIInput.open

Properties

charging?: boolean
chargingTime?: number
dischargingTime?: number
level?: number
onmidimessage: null | ((this: MIDIInput, ev: MIDIMessageEvent) => any)

MDN Reference

connection: MIDIPortConnectionState

MDN Reference

id: string

MDN Reference

manufacturer: null | string

MDN Reference

name: null | string

MDN Reference

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

MDN Reference

state: MIDIPortDeviceState

MDN Reference

type: MIDIPortType

MDN Reference

version: null | string

MDN Reference

Methods

dispatchEvent(event: Event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

Returns boolean

addEventListener<K extends keyof MIDIInputEventMap>(
    type: K,
    listener: (this: MIDIInput, ev: MIDIInputEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Type Parameters

Parameters

Returns void

addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Parameters

Returns void

removeEventListener<K extends keyof MIDIInputEventMap>(
    type: K,
    listener: (this: MIDIInput, ev: MIDIInputEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Type Parameters

Parameters

Returns void

removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters

Returns void

close(): Promise<MIDIPort>

MDN Reference

Returns Promise<MIDIPort>

open(): Promise<MIDIPort>

MDN Reference

Returns Promise<MIDIPort>