Class MIDI

This class is for using Web MIDI API.

Hierarchy

MIDI

Index

Constructors

Properties

inputs midiAccess outputs

Methods

Constructors

constructor

new MIDI(): MIDI
Returns MIDI
- Defined in MIDI/index.ts:11

Properties

`Private` inputs

inputs: MIDIInput[] = []

`Private` midiAccess

midiAccess: null | MIDIAccess = null

`Private` outputs

outputs: MIDIOutput[] = []

Methods

get

get(): null | MIDIAccess
This method gets instance of MIDIAccess.

Returns null | MIDIAccess
- Defined in MIDI/index.ts:59

setup

setup(params): Promise<void | MIDIAccess>
This method invokes requestMIDIAccess and gets instance of MIDIAccess.
Parameters
- params: {
      options?: MIDIOptions;
      errorCallback?(error) => void;
      successCallback?(midiAccess, midiInputs, midiOutputs) => void;
  }
  - Optional options?: MIDIOptions
  - errorCallback?:function
    - errorCallback(error): void
    - Parameters
      
      error: Error
      
      Returns void
      
      Defined in MIDI/index.ts:24
  - successCallback?:function
    - successCallback(midiAccess, midiInputs, midiOutputs): void
    - Parameters
      
      midiAccess: MIDIAccess
      
      midiInputs: MIDIInput[]
      
      midiOutputs: MIDIOutput[]
      
      Returns void
      
      Defined in MIDI/index.ts:23
Returns Promise<void | MIDIAccess>
Return value is Promise that requestMIDIAccess method returns.
- Defined in MIDI/index.ts:21

Generated using TypeDoc