7c9d5ace |
1 | # group `midi_util` {#group__midi__util} |
2 | |
3 | ## Summary |
4 | |
5 | Members | Descriptions |
6 | --------------------------------|--------------------------------------------- |
7 | `enum `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e) | An enumeration of the possible packet length values. |
8 | `public bool `[`midi_is_statusbyte`](#group__midi__util_1ga12e3b42ff9cbb4b4f2bc455fc8743ee5)`(uint8_t theByte)` | Test to see if the byte given is a status byte. |
9 | `public bool `[`midi_is_realtime`](#group__midi__util_1gad2f52c363e34a8000d80c983c324e2d7)`(uint8_t theByte)` | Test to see if the byte given is a realtime message. |
10 | `public `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e)` `[`midi_packet_length`](#group__midi__util_1gaa168b43af6ae9de0debce1625e4b8175)`(uint8_t status)` | Find the length of the packet associated with the status byte given. |
11 | |
12 | ## Members |
13 | |
14 | #### `enum `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e) {#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e} |
15 | |
16 | Values | Descriptions |
17 | --------------------------------|--------------------------------------------- |
18 | UNDEFINED | |
19 | ONE | |
20 | TWO | |
21 | THREE | |
22 | |
23 | An enumeration of the possible packet length values. |
24 | |
25 | #### `public bool `[`midi_is_statusbyte`](#group__midi__util_1ga12e3b42ff9cbb4b4f2bc455fc8743ee5)`(uint8_t theByte)` {#group__midi__util_1ga12e3b42ff9cbb4b4f2bc455fc8743ee5} |
26 | |
27 | Test to see if the byte given is a status byte. |
28 | |
29 | #### Parameters |
30 | * `theByte` the byte to test |
31 | |
32 | #### Returns |
33 | true if the byte given is a midi status byte |
34 | |
35 | #### `public bool `[`midi_is_realtime`](#group__midi__util_1gad2f52c363e34a8000d80c983c324e2d7)`(uint8_t theByte)` {#group__midi__util_1gad2f52c363e34a8000d80c983c324e2d7} |
36 | |
37 | Test to see if the byte given is a realtime message. |
38 | |
39 | #### Parameters |
40 | * `theByte` the byte to test |
41 | |
42 | #### Returns |
43 | true if it is a realtime message, false otherwise |
44 | |
45 | #### `public `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e)` `[`midi_packet_length`](#group__midi__util_1gaa168b43af6ae9de0debce1625e4b8175)`(uint8_t status)` {#group__midi__util_1gaa168b43af6ae9de0debce1625e4b8175} |
46 | |
47 | Find the length of the packet associated with the status byte given. |
48 | |
49 | #### Parameters |
50 | * `status` the status byte |
51 | |
52 | #### Returns |
53 | the length of the packet, will return UNDEFINED if the byte is not a status byte or if it is a sysex status byte |
54 | |