Interface MIDIInputMap

The MIDIInputMap read-only interface of the Web MIDI API provides the set of MIDI input ports that are currently available. Available only in secure contexts.

interface MIDIInputMap {
    size: number;
    "[iterator]"(): MapIterator<[string, MIDIInput]>;
    entries(): MapIterator<[string, MIDIInput]>;
    forEach(
        callbackfn: (
            value: MIDIInput,
            key: string,
            parent: MIDIInputMap,
        ) => void,
        thisArg?: any,
    ): void;
    get(key: string): MIDIInput | undefined;
    has(key: string): boolean;
    keys(): MapIterator<string>;
    values(): MapIterator<MIDIInput>;
}

Hierarchy

ReadonlyMap<string, MIDIInput>
- MIDIInputMap

Index

Properties

Methods

[iterator] entries forEach get has keys values

Properties

`Readonly`size

size: number

Methods

[iterator]

"[iterator]"(): MapIterator<[string, MIDIInput]>
Returns an iterable of entries in the map.

Returns MapIterator<[string, MIDIInput]>

entries

entries(): MapIterator<[string, MIDIInput]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[string, MIDIInput]>

forEach

forEach(
    callbackfn: (
        value: MIDIInput,
        key: string,
        parent: MIDIInputMap,
    ) => void,
    thisArg?: any,
): void
Parameters
- callbackfn: (value: MIDIInput, key: string, parent: MIDIInputMap) => void
- OptionalthisArg: any
Returns void

get

get(key: string): MIDIInput | undefined
Parameters
- key: string
Returns MIDIInput | undefined

has

has(key: string): boolean
Parameters
- key: string
Returns boolean

keys

keys(): MapIterator<string>
Returns an iterable of keys in the map

Returns MapIterator<string>

values

values(): MapIterator<MIDIInput>
Returns an iterable of values in the map

Returns MapIterator<MIDIInput>