Package com.bitwig.extension.controller.api

Interface MidiOut

public interface MidiOut
Instances of this interface are used to send MIDI messages to a specific MIDI hardware.
Since:
API version 1

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    sendMidi(int status, int data1, int data2)
    Sends a MIDI message to the hardware device.
    void
    sendSysex(byte[] data)
    Sends a MIDI SysEx message to the hardware device.
    void
    sendSysex(String hexString)
    Sends a MIDI SysEx message to the hardware device.
    void
    sendSysexBytes(byte[] data)
    Sends a MIDI SysEx message to the hardware device.
    void
    setShouldSendMidiBeatClock(boolean shouldSendClock)
    Deprecated.
    Users should enable the clock from the settings.

  • Method Details

    • sendMidi

      void sendMidi(int status, int data1, int data2)
      Sends a MIDI message to the hardware device.
      Parameters:
      status - the status byte of the MIDI message, system messages are not permitted.
      data1 - the data1 part of the MIDI message
      data2 - the data2 part of the MIDI message
      Since:
      API version 1

    • sendSysex

      void sendSysex(String hexString)
      Sends a MIDI SysEx message to the hardware device. Starting from API version 19, sending invalid sysex will crash the ControllerExtension.
      Parameters:
      hexString - the sysex message formatted as hexadecimal value string
      Since:
      API version 1

    • sendSysex

      void sendSysex(byte[] data)
      Sends a MIDI SysEx message to the hardware device. Starting from API version 19, sending invalid sysex will crash the ControllerExtension.
      Parameters:
      data - the array of bytes to send
      Since:
      API version 2

    • sendSysexBytes

      void sendSysexBytes(byte[] data)
      Sends a MIDI SysEx message to the hardware device. This method is identical to sendSysex(byte[]) but exists so that Javascript controllers can explicitly call this method instead of relying on some intelligent overload resolution of the Javascript engine based on its loose type system. Starting from API version 19, sending invalid sysex will crash the ControllerExtension.
      Parameters:
      data - the array of bytes to send
      Since:
      API version 2

    • setShouldSendMidiBeatClock

      @Deprecated void setShouldSendMidiBeatClock(boolean shouldSendClock)
      Deprecated.
      Users should enable the clock from the settings.
      Enables or disables sending MIDI beat clock messages to the hardware depending on the given parameter. Typically MIDI devices that run an internal sequencer such as hardware step sequencers would be interested in MIDI clock messages.
      Parameters:
      shouldSendClock - `true` in case the hardware should receive MIDI clock messages, `false` otherwise
      Since:
      API version 1