mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-12-26 02:58:06 +06:00
Code Issues Packages Projects Releases Wiki Activity
d965d72d4a
keychron_qmk_firmware/docs/api_midi_util.md
skullydazed 7c9d5ace14 Generate API docs from source code comments (#2491) 
* 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
2018-03-22 02:50:38 -04:00

2.5 KiB
Raw Blame History

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