InputEventMidi
Represents a MIDI message from a MIDI device, such as a musical keyboard.
Represents a MIDI message from a MIDI device, such as a musical keyboard.
InputEventMIDI stores information about messages from MIDI(https://en.wikipedia.org/wiki/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, Reckfell does not detect MIDI devices. You need to call OS.OpenMidiInputs, first. You can check which devices are detected with OS.GetConnectedMidiInputs, and close the connection with OS.CloseMidiInputs.
public override void _Ready()
{
OS.OpenMidiInputs();
ReckfellApi.Print(OS.GetConnectedMidiInputs());
}
public override void _Input(InputEvent inputEvent)
{
if (inputEvent is InputEventMidi midiEvent)
{
PrintMIDIInfo(midiEvent);
}
}
private void PrintMIDIInfo(InputEventMidi midiEvent)
{
ReckfellApi.Print(midiEvent);
ReckfellApi.Print($"Channel {midiEvent.Channel}");
ReckfellApi.Print($"Message {midiEvent.Message}");
ReckfellApi.Print($"Pitch {midiEvent.Pitch}");
ReckfellApi.Print($"Velocity {midiEvent.Velocity}");
ReckfellApi.Print($"Instrument {midiEvent.Instrument}");
ReckfellApi.Print($"Pressure {midiEvent.Pressure}");
ReckfellApi.Print($"Controller number: {midiEvent.ControllerNumber}");
ReckfellApi.Print($"Controller value: {midiEvent.ControllerValue}");
}Note: Reckfell does not support MIDI output, so there is no way to emit MIDI messages from Reckfell. 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 OS.OpenMidiInputs. MIDI input will not work until the user accepts the permission request.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
InputEventMidiConstructor
public InputEventMidi();Properties8
ChannelProperty
public int Channel { get; set; }The MIDI channel of this message, ranging from 0 to 15. MIDI channel 9 is reserved for percussion instruments.
ControllerNumberProperty
public int ControllerNumber { get; set; }The unique number of the controller, if InputEventMidi.Message is 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.
ControllerValueProperty
public int ControllerValue { get; set; }The value applied to the controller. If InputEventMidi.Message is MIDI_MESSAGE_CONTROL_CHANGE, this value ranges from 0 to 127, otherwise it is 0. See also InputEventMidi.ControllerValue.
InstrumentProperty
public int Instrument { get; set; }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.
MessageProperty
public MidiMessage Message { get; set; }Represents the type of MIDI message (see the MIDIMessage enum).
For more information, see the MIDI message status byte list chart.
PitchProperty
public int Pitch { get; set; }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.
PressureProperty
public int Pressure { get; set; }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 InputEventMidi.Velocity, instead.
VelocityProperty
public int Velocity { get; set; }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 MIDI_MESSAGE_NOTE_ON message with 0 velocity and expect it to be treated the same as a MIDI_MESSAGE_NOTE_OFF message. If necessary, this can be handled with a few lines of code:
Methods16
GetChannelint
public int GetChannel();intGetControllerNumberint
public int GetControllerNumber();intGetControllerValueint
public int GetControllerValue();intGetInstrumentint
public int GetInstrument();intGetMessageMidiMessage
public MidiMessage GetMessage();MidiMessageGetPitchint
public int GetPitch();intGetPressureint
public int GetPressure();intGetVelocityint
public int GetVelocity();intSetChannelvoid
public void SetChannel(int channel);| Name | Type | Default |
|---|---|---|
channel | int | — |
SetControllerNumbervoid
public void SetControllerNumber(int controllerNumber);| Name | Type | Default |
|---|---|---|
controllerNumber | int | — |
SetControllerValuevoid
public void SetControllerValue(int controllerValue);| Name | Type | Default |
|---|---|---|
controllerValue | int | — |
SetInstrumentvoid
public void SetInstrument(int instrument);| Name | Type | Default |
|---|---|---|
instrument | int | — |
SetMessagevoid
public void SetMessage(MidiMessage message);| Name | Type | Default |
|---|---|---|
message | MidiMessage | — |
SetPitchvoid
public void SetPitch(int pitch);| Name | Type | Default |
|---|---|---|
pitch | int | — |
SetPressurevoid
public void SetPressure(int pressure);| Name | Type | Default |
|---|---|---|
pressure | int | — |
SetVelocityvoid
public void SetVelocity(int velocity);| Name | Type | Default |
|---|---|---|
velocity | int | — |