qmk_firmware/docs/internals_midi_util.md

group midi_util

Summary

Members	Descriptions
enum midi_packet_length_t	An enumeration of the possible packet length values.
public bool midi_is_statusbyte(uint8_t theByte)	Test to see if the byte given is a status byte.
public bool midi_is_realtime(uint8_t theByte)	Test to see if the byte given is a realtime message.
public midi_packet_length_t midi_packet_length(uint8_t status)	Find the length of the packet associated with the status byte given.

Members

enum midi_packet_length_t

Values	Descriptions
UNDEFINED
ONE
TWO
THREE

An enumeration of the possible packet length values.

public bool midi_is_statusbyte(uint8_t theByte)

Test to see if the byte given is a status byte.

Parameters

• theByte the byte to test

Returns

true if the byte given is a midi status byte

public bool midi_is_realtime(uint8_t theByte)

Test to see if the byte given is a realtime message.

Parameters

• theByte the byte to test

Returns

true if it is a realtime message, false otherwise

public midi_packet_length_t midi_packet_length(uint8_t status)

Find the length of the packet associated with the status byte given.

Parameters

• status the status byte

Returns

the length of the packet, will return UNDEFINED if the byte is not a status byte or if it is a sysex status byte