Bitwig Studio Control Surface API  5.0.11
MidiOut Interface Reference

Public Member Functions

void sendMidi (int status, int data1, int data2)
 
void sendSysex (String hexString)
 
void sendSysex (byte[] data)
 
void sendSysexBytes (byte[] data)
 
void setShouldSendMidiBeatClock (boolean shouldSendClock)
 

Detailed Description

Instances of this interface are used to send MIDI messages to a specific MIDI hardware.

Since
API version 1

Member Function Documentation

◆ sendMidi()

void sendMidi ( int  status,
int  data1,
int  data2 
)

Sends a MIDI message to the hardware device.

Parameters
statusthe status byte of the MIDI message, system messages are not permitted.
data1the data1 part of the MIDI message
data2the data2 part of the MIDI message
Since
API version 1

◆ sendSysex() [1/2]

void sendSysex ( byte[]  data)

Sends a MIDI SysEx message to the hardware device.

Parameters
datathe array of bytes to send
Since
API version 2

◆ sendSysex() [2/2]

void sendSysex ( String  hexString)

Sends a MIDI SysEx message to the hardware device.

Parameters
hexStringthe sysex message formatted as hexadecimal value string
Since
API version 1

◆ 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.

Parameters
datathe array of bytes to send
Since
API version 2

◆ setShouldSendMidiBeatClock()

void setShouldSendMidiBeatClock ( boolean  shouldSendClock)

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
shouldSendClocktrue in case the hardware should receive MIDI clock messages, false otherwise
Deprecated:
Users should enable the clock from the settings.
Since
API version 1

The documentation for this interface was generated from the following file: