qmk_firmware/docs/internals_midi_util.md

group midi_util {#groupmidiutil}

Summary

Members	Descriptions
enummidi_packet_length_t	An enumeration of the possible packet length values.
public boolmidi_is_statusbyte(uint8_t theByte)	Test to see if the byte given is a status byte.
public boolmidi_is_realtime(uint8_t theByte)	Test to see if the byte given is a realtime message.
publicmidi_packet_length_tmidi_packet_length(uint8_t status)	Find the length of the packet associated with the status byte given.

Members

enummidi_packet_length_t {#groupmidiutil_1gae29ff56aee2b430ffe53933b97e5e79e}

Values	Descriptions
UNDEFINED
ONE
TWO
THREE

An enumeration of the possible packet length values.

public boolmidi_is_statusbyte(uint8_t theByte) {#groupmidiutil_1ga12e3b42ff9cbb4b4f2bc455fc8743ee5}

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 boolmidi_is_realtime(uint8_t theByte) {#groupmidiutil_1gad2f52c363e34a8000d80c983c324e2d7}

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

publicmidi_packet_length_tmidi_packet_length(uint8_t status) {#groupmidiutil_1gaa168b43af6ae9de0debce1625e4b8175}

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