Table of Contents

Class InputEventMIDI

Represents a MIDI message from a MIDI device, such as a musical keyboard.

Inheritance
InputEventMIDI

Remarks

InputEventMIDI stores information about messages from MIDI (Musical Instrument Digital Interface) devices. These may include musical keyboards, synthesizers, and drum machines.

MIDI messages can be received over a 5-pin MIDI connector or over USB. If your device supports both be sure to check the settings in the device to see which output it is using.

By default, Godot does not detect MIDI devices. You need to call open_midi_inputs, first. You can check which devices are detected with get_connected_midi_inputs, and close the connection with close_midi_inputs.

func _ready():
    OS.open_midi_inputs()
    print(OS.get_connected_midi_inputs())

func _input(input_event):
    if input_event is InputEventMIDI:
        _print_midi_info(input_event)

func _print_midi_info(midi_event):
    print(midi_event)
    print("Channel ", midi_event.channel)
    print("Message ", midi_event.message)
    print("Pitch ", midi_event.pitch)
    print("Velocity ", midi_event.velocity)
    print("Instrument ", midi_event.instrument)
    print("Pressure ", midi_event.pressure)
    print("Controller number: ", midi_event.controller_number)
    print("Controller value: ", midi_event.controller_value)

Note: Godot does not support MIDI output, so there is no way to emit MIDI messages from Godot. Only MIDI input is supported.

Note: On the Web platform, using MIDI input requires a browser permission to be granted first. This permission request is performed when calling open_midi_inputs. MIDI input will not work until the user accepts the permission request.

See Also

MIDI Message Status Byte List
Wikipedia General MIDI Instrument List
Wikipedia Piano Key Frequencies List

Properties

channel

The MIDI channel of this message, ranging from 0 to 15. MIDI channel 9 is reserved for percussion instruments.

var channel : int = 0

Property Value

int

Remarks

  • void set_channel(int value)
  • int get_channel

controller_number

The unique number of the controller, if message is @GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE, otherwise this is 0. This value can be used to identify sliders for volume, balance, and panning, as well as switches and pedals on the MIDI device. See the General MIDI specification for a small list.

var controller_number : int = 0

Property Value

int

Remarks

  • void set_controller_number(int value)
  • int get_controller_number

controller_value

The value applied to the controller. If message is @GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE, this value ranges from 0 to 127, otherwise it is 0. See also controller_value.

var controller_value : int = 0

Property Value

int

Remarks

  • void set_controller_value(int value)
  • int get_controller_value

instrument

The instrument (also called program or preset) used on this MIDI message. This value ranges from 0 to 127.

To see what each value means, refer to the General MIDI's instrument list. Keep in mind that the list is off by 1 because it does not begin from 0. A value of 0 corresponds to the acoustic grand piano.

var instrument : int = 0

Property Value

int

Remarks

  • void set_instrument(int value)
  • int get_instrument

message

Represents the type of MIDI message (see the MIDIMessage enum).

For more information, see the MIDI message status byte list chart.

var message : int = 0

Property Value

int

Remarks

  • void set_message(int value)
  • int get_message

pitch

The pitch index number of this MIDI message. This value ranges from 0 to 127.

On a piano, the middle C is 60, followed by a C-sharp (61), then a D (62), and so on. Each octave is split in offsets of 12. See the "MIDI note number" column of the piano key frequency chart a full list.

var pitch : int = 0

Property Value

int

Remarks

  • void set_pitch(int value)
  • int get_pitch

pressure

The strength of the key being pressed. This value ranges from 0 to 127.

Note: For many devices, this value is always 0. Other devices such as musical keyboards may simulate pressure by changing the velocity, instead.

var pressure : int = 0

Property Value

int

Remarks

  • void set_pressure(int value)
  • int get_pressure

velocity

The velocity of the MIDI message. This value ranges from 0 to 127. For a musical keyboard, this corresponds to how quickly the key was pressed, and is rarely above 110 in practice.

Note: Some MIDI devices may send a @GlobalScope.MIDI_MESSAGE_NOTE_ON message with 0 velocity and expect it to be treated the same as a @GlobalScope.MIDI_MESSAGE_NOTE_OFF message. If necessary, this can be handled with a few lines of code:

func _input(event):
    if event is InputEventMIDI:
        if event.message == MIDI_MESSAGE_NOTE_ON and event.velocity > 0:
            print("Note pressed!")


var velocity : int = 0

Property Value

int

Remarks

  • void set_velocity(int value)
  • int get_velocity