forked from mirrors/qmk_firmware
7c9d5ace14
* Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly
2.5 KiB
2.5 KiB
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
theBytethe 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
theBytethe 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
statusthe 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