Class HSMIDIDevice

constructor

• new HSMIDIDevice(): HSMIDIDevice

  Returns HSMIDIDevice

ReadonlydisplayName

Readonlyidentifier

ReadonlyisOnline

ReadonlyisVirtual

Readonlymanufacturer

Readonlymodel

Readonlyname

destroy

• destroy(): void

  Stops receiving from and releases all resources held by this device object. Called automatically when Hammerspoon reloads.

  Returns void

identityRequest

• identityRequest(): void

  Sends a MIDI Identity Request. The device's reply, if any, arrives via the callback set with setCallback() as a systemExclusive message.

  Returns void

sendCommand

• sendCommand(commandType: string, metadata: object): boolean

  Sends a MIDI command to the device.

  Parameters

  • commandType: string

    The command type string

  • metadata: object

    A table of command-specific fields

  Returns boolean

  true if the command was sent, false if the device has no

sendSysex

• sendSysex(command: string): void

  Sends a System Exclusive command to the device.

  Parameters

  • command: string

    A hex string (whitespace ignored), e.g. "F0 7E 7F 06 01 F7"

  Returns void

setCallback

• setCallback(
      fn:
          | (
              (
                  device: HSMIDIDevice,
                  deviceName: string,
                  commandType: string,
                  description: string,
                  metadata: object,
              ) => void
          )
          | null,
  ): HSMIDIDevice

  Sets or removes the callback fired when a MIDI message is received. The callback receives five arguments: this device object, the device's name, the command type as a string (e.g. "noteOn", "controlChange", "systemExclusive" — see hs.midi.commandTypes for the full set), a human-readable description, and a metadata table of command-specific fields. when released, but some send noteOn with velocity 0 instead of noteOff.

  Parameters

  • fn:
        | (
            (
                device: HSMIDIDevice,
                deviceName: string,
                commandType: string,
                description: string,
                metadata: object,
            ) => void
        )
        | null

    The function to call on each received message, or null to remove it

  Returns HSMIDIDevice

  This device object, for chaining