Control Surface API  2.2.2
MidiIn Interface Reference

Public Member Functions

void setMidiCallback (ShortMidiDataReceivedCallback callback)
 
void setSysexCallback (SysexMidiDataReceivedCallback callback)
 
NoteInput createNoteInput (String name, String...masks)
 

Detailed Description

Instances of this interface are used to setup handler functions for incoming MIDI messages from a specific MIDI hardware.

Since
API version 1

Definition at line 12 of file MidiIn.java.

Member Function Documentation

NoteInput createNoteInput ( String  name,
String...  masks 
)

Creates a note input that appears in the track input choosers in Bitwig Studio. This method must be called within the init() function of the script. The messages matching the given mask parameter will be fed directly to the application, and are not processed by the script.

Parameters
namethe name of the note input as it appears in the track input choosers in Bitwig Studio
masksa filter string formatted as hexadecimal value with ? as wildcard. For example 80???? would match note-off on channel 1 (0). When this parameter is {}, a standard filter will be used to forward note-related messages on channel 1 (0).

If multiple note input match the same MIDI event then they'll all receive the MIDI event, and if one of them does not consume events then the events wont' be consumed.

Returns
the object representing the requested note input
Since
API version 1
void setMidiCallback ( ShortMidiDataReceivedCallback  callback)

Registers a callback for receiving short (normal) MIDI messages on this MIDI input port.

Parameters
callbacka callback function that receives three integer parameters: 1. the status byte 2. the data1 value 2. the data2 value @
Since
API version 1
void setSysexCallback ( SysexMidiDataReceivedCallback  callback)

Registers a callback for receiving sysex MIDI messages on this MIDI input port.

Parameters
callbacka callback function that takes a single string argument @
Since
API version 1

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