Class MidiManager

Midi Manager makes simplifies connecting to ports and having omni input/output

const midi = new MidiManager(); // By default connects to all ins and outs
midi.addEventListener(`message`, event => {
 // Do something with received MIDI data from any input
})

midi.scan();
midi.send({ command: `cc`, note: 10, channel: 1, velocity: 20 });

// Sends note '10' on channel 1, velocity 100, duration 200ms 
midi.sendNote(1, 10, 100, 200);

Events:

open/close: Connected port is open/closed
deviceConnected/deviceDisconnected: A port is newly available or unavailable
message: MIDI event received

Hierarchy (View Summary)

SimpleEventEmitter<MidiManagerEvents>
- MidiManager

Index

Accessors

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from SimpleEventEmitter.isDisposed
- Defined in events/src/simple-event-emitter.ts:13

omniInput

get omniInput(): boolean
Returns boolean
- Defined in io/src/midi/manager.ts:258

omniOutput

get omniOutput(): boolean
Returns boolean
- Defined in io/src/midi/manager.ts:271

Constructors

constructor

new MidiManager(): MidiManager
Returns MidiManager
Overrides SimpleEventEmitter.constructor
- Defined in io/src/midi/manager.ts:55

Methods

addEventListener

addEventListener<K extends keyof MidiManagerEvents>(
    name: K,
    listener: (
        event: MidiManagerEvents[K],
        sender: SimpleEventEmitter<MidiManagerEvents>,
    ) => void,
): void
Adds event listener.
Type Parameters
- K extends keyof MidiManagerEvents
  Events
Parameters
- name: K
  Event name
- listener: (
  event: MidiManagerEvents[K],
  sender: SimpleEventEmitter<MidiManagerEvents>,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed
Inherited from SimpleEventEmitter.addEventListener
- Defined in events/src/simple-event-emitter.ts:39

closeAll

closeAll(what?: "both" | "input" | "output"): Promise<void>
Parameters
- what: "both" | "input" | "output" = ...
Returns Promise<void>
- Defined in io/src/midi/manager.ts:238

dispose

dispose(): void
Returns void
Inherited from SimpleEventEmitter.dispose
- Defined in events/src/simple-event-emitter.ts:8

dumpToStringLines

dumpToStringLines(): string[]
Returns string[]
- Defined in io/src/midi/manager.ts:297

filterInUsePort

filterInUsePort(
fn: (p: MIDIPort) => boolean,
): Generator<MIDIPort, void, unknown>
Parameters
- fn: (p: MIDIPort) => boolean
Returns Generator<MIDIPort, void, unknown>
- Defined in io/src/midi/manager.ts:407

filterKnownPort

filterKnownPort(
fn: (p: MIDIPort) => boolean,
): Generator<MIDIPort, void, unknown>
Parameters
- fn: (p: MIDIPort) => boolean
Returns Generator<MIDIPort, void, unknown>
- Defined in io/src/midi/manager.ts:401

findInUsePort

findInUsePort(fn: (p: MIDIPort) => boolean): undefined | MIDIPort
Parameters
- fn: (p: MIDIPort) => boolean
Returns undefined | MIDIPort
- Defined in io/src/midi/manager.ts:404

findKnownPort

findKnownPort(fn: (p: MIDIPort) => boolean): undefined | MIDIPort
Parameters
- fn: (p: MIDIPort) => boolean
Returns undefined | MIDIPort
- Defined in io/src/midi/manager.ts:398

`Protected`fireEvent

fireEvent<K extends keyof MidiManagerEvents>(
type: K,
args: MidiManagerEvents[K],
): void
Fire event
Type Parameters
- K extends keyof MidiManagerEvents
Parameters
- type: K
  Type of event
- args: MidiManagerEvents[K]
  Arguments for event
Returns void
Inherited from SimpleEventEmitter.fireEvent
- Defined in events/src/simple-event-emitter.ts:23

getInUse

getInUse(): Generator<MIDIPort, void, unknown>
Returns Generator<MIDIPort, void, unknown>
- Defined in io/src/midi/manager.ts:64

getInUseInput

getInUseInput(): Generator<MIDIInput, void, unknown>
Returns Generator<MIDIInput, void, unknown>
- Defined in io/src/midi/manager.ts:68

getInUseOutput

getInUseOutput(): Generator<MIDIOutput, void, unknown>
Returns Generator<MIDIOutput, void, unknown>
- Defined in io/src/midi/manager.ts:74

known

known(): Generator<MIDIPort, void, unknown>
Returns Generator<MIDIPort, void, unknown>
- Defined in io/src/midi/manager.ts:80

knownInput

knownInput(): Generator<MIDIInput, void, unknown>
Returns Generator<MIDIInput, void, unknown>
- Defined in io/src/midi/manager.ts:84

knownOutput

knownOutput(): Generator<MIDIOutput, void, unknown>
Returns Generator<MIDIOutput, void, unknown>
- Defined in io/src/midi/manager.ts:92

open

open(port: MIDIPort, exclusive?: boolean): Promise<void>
Opens port.

If exclusive is true, all other ports of that type (ie. input or output) are closed before the port is opened.

If exclusive is false (default), already open ports are left open.
Parameters
- port: MIDIPort
- exclusive: boolean = false
Returns Promise<void>
- Defined in io/src/midi/manager.ts:344

removeEventListener

removeEventListener<K extends keyof MidiManagerEvents>(
    type: K,
    listener: (
        event: MidiManagerEvents[K],
        sender: SimpleEventEmitter<MidiManagerEvents>,
    ) => void,
): void
Remove event listener
Type Parameters
- K extends keyof MidiManagerEvents
Parameters
- type: K
- listener: (
  event: MidiManagerEvents[K],
  sender: SimpleEventEmitter<MidiManagerEvents>,
  ) => void
Returns void
Inherited from SimpleEventEmitter.removeEventListener
- Defined in events/src/simple-event-emitter.ts:55

scan

scan(): Promise<void>
Returns Promise<void>
- Defined in io/src/midi/manager.ts:100

send

send(message: MidiMessage, port?: MIDIOutput, timestamp?: number): void
Sends a message to a port.

If port is omitted, all open output ports are used.
Parameters
- message: MidiMessage
- Optionalport: MIDIOutput
- Optionaltimestamp: number
Returns void
- Defined in io/src/midi/manager.ts:123

sendNote

sendNote(
    channel: number,
    note: number,
    velocity: number,
    duration: number,
    delay?: number,
    port?: MIDIOutput,
): void
Parameters
- channel: number
- note: number
- velocity: number
- duration: number
- Optionaldelay: number
- Optionalport: MIDIOutput
Returns void
- Defined in io/src/midi/manager.ts:138

setOmniInput

setOmniInput(value: boolean): Promise<void>
Parameters
- value: boolean
Returns Promise<void>
- Defined in io/src/midi/manager.ts:250

setOmniOutput

setOmniOutput(value: boolean): Promise<void>
Parameters
- value: boolean
Returns Promise<void>
- Defined in io/src/midi/manager.ts:262

Properties

verbose

verbose: boolean = true

Class MidiManager

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

isDisposed

Returns boolean

omniInput

Returns boolean

omniOutput

Returns boolean

Constructors

constructor

Returns MidiManager

Methods

addEventListener

Type Parameters

Parameters

Returns void

Throws

closeAll

Parameters

Returns Promise<void>

dispose

Returns void

dumpToStringLines

Returns string[]

filterInUsePort

Parameters

Returns Generator<MIDIPort, void, unknown>

filterKnownPort

Parameters

Returns Generator<MIDIPort, void, unknown>

findInUsePort

Parameters

Returns undefined | MIDIPort

findKnownPort

Parameters

Returns undefined | MIDIPort

ProtectedfireEvent

Type Parameters

Parameters

Returns void

getInUse

Returns Generator<MIDIPort, void, unknown>

getInUseInput

Returns Generator<MIDIInput, void, unknown>

getInUseOutput

Returns Generator<MIDIOutput, void, unknown>

known

Returns Generator<MIDIPort, void, unknown>

knownInput

Returns Generator<MIDIInput, void, unknown>

knownOutput

Returns Generator<MIDIOutput, void, unknown>

open

Parameters

Returns Promise<void>

removeEventListener

Type Parameters

Parameters

Returns void

scan

Returns Promise<void>

send

Parameters

Returns void

sendNote

Parameters

Returns void

setOmniInput

Parameters

Returns Promise<void>

setOmniOutput

Parameters

Returns Promise<void>

Properties

`Protected`fireEvent