diff options
Diffstat (limited to 'docs/internals_input_callback_reg.md')
| -rw-r--r-- | docs/internals_input_callback_reg.md | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/docs/internals_input_callback_reg.md b/docs/internals_input_callback_reg.md new file mode 100644 index 000000000..4ea132a83 --- /dev/null +++ b/docs/internals_input_callback_reg.md | |||
| @@ -0,0 +1,169 @@ | |||
| 1 | # group `input_callback_reg` {#group__input__callback__reg} | ||
| 2 | |||
| 3 | These are the functions you use to register your input callbacks. | ||
| 4 | |||
| 5 | The functions are called when the appropriate midi message is matched on the associated device's input. | ||
| 6 | |||
| 7 | ## Summary | ||
| 8 | |||
| 9 | Members | Descriptions | ||
| 10 | --------------------------------|--------------------------------------------- | ||
| 11 | `public void `[`midi_register_cc_callback`](#group__input__callback__reg_1ga64ab672abbbe393c9c4a83110c8df718)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | Register a control change message (cc) callback. | ||
| 12 | `public void `[`midi_register_noteon_callback`](#group__input__callback__reg_1ga3962f276c17618923f1152779552103e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | Register a note on callback. | ||
| 13 | `public void `[`midi_register_noteoff_callback`](#group__input__callback__reg_1gac847b66051bd6d53b762958be0ec4c6d)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | Register a note off callback. | ||
| 14 | `public void `[`midi_register_aftertouch_callback`](#group__input__callback__reg_1gaa95bc901bd9edff956a667c9a69dd01f)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | Register an after touch callback. | ||
| 15 | `public void `[`midi_register_pitchbend_callback`](#group__input__callback__reg_1ga071a28f02ba14f53de219be70ebd9a48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | Register a pitch bend callback. | ||
| 16 | `public void `[`midi_register_songposition_callback`](#group__input__callback__reg_1gaf2adfd79637f3553d8f26deb1ca22ed6)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | Register a song position callback. | ||
| 17 | `public void `[`midi_register_progchange_callback`](#group__input__callback__reg_1gae6ba1a35a4cde9bd15dd42f87401d127)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | Register a program change callback. | ||
| 18 | `public void `[`midi_register_chanpressure_callback`](#group__input__callback__reg_1ga39b31f1f4fb93917ce039b958f21b4f5)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | Register a channel pressure callback. | ||
| 19 | `public void `[`midi_register_songselect_callback`](#group__input__callback__reg_1gaf9aafc76a2dc4b9fdbb4106cbda6ce72)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | Register a song select callback. | ||
| 20 | `public void `[`midi_register_tc_quarterframe_callback`](#group__input__callback__reg_1ga0a119fada2becc628cb15d753b257e6e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | Register a tc quarter frame callback. | ||
| 21 | `public void `[`midi_register_realtime_callback`](#group__input__callback__reg_1ga764f440e857b89084b1a07f9da2ff93a)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` | Register a realtime callback. | ||
| 22 | `public void `[`midi_register_tunerequest_callback`](#group__input__callback__reg_1gae40ff3ce20bda79fef87da24b8321cb1)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` | Register a tune request callback. | ||
| 23 | `public void `[`midi_register_sysex_callback`](#group__input__callback__reg_1ga63ce9631b025785c1848d0122d4c4c48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_sysex_func_t func)` | Register a sysex callback. | ||
| 24 | `public void `[`midi_register_fallthrough_callback`](#group__input__callback__reg_1ga7ed189164aa9682862b3181153afbd94)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` | Register fall through callback. | ||
| 25 | `public void `[`midi_register_catchall_callback`](#group__input__callback__reg_1ga9dbfed568d047a6cd05708f11fe39e99)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` | Register a catch all callback. | ||
| 26 | |||
| 27 | ## Members | ||
| 28 | |||
| 29 | #### `public void `[`midi_register_cc_callback`](#group__input__callback__reg_1ga64ab672abbbe393c9c4a83110c8df718)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1ga64ab672abbbe393c9c4a83110c8df718} | ||
| 30 | |||
| 31 | Register a control change message (cc) callback. | ||
| 32 | |||
| 33 | #### Parameters | ||
| 34 | * `device` the device associate with | ||
| 35 | |||
| 36 | * `func` the callback function to register | ||
| 37 | |||
| 38 | #### `public void `[`midi_register_noteon_callback`](#group__input__callback__reg_1ga3962f276c17618923f1152779552103e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1ga3962f276c17618923f1152779552103e} | ||
| 39 | |||
| 40 | Register a note on callback. | ||
| 41 | |||
| 42 | #### Parameters | ||
| 43 | * `device` the device associate with | ||
| 44 | |||
| 45 | * `func` the callback function to register | ||
| 46 | |||
| 47 | #### `public void `[`midi_register_noteoff_callback`](#group__input__callback__reg_1gac847b66051bd6d53b762958be0ec4c6d)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1gac847b66051bd6d53b762958be0ec4c6d} | ||
| 48 | |||
| 49 | Register a note off callback. | ||
| 50 | |||
| 51 | #### Parameters | ||
| 52 | * `device` the device associate with | ||
| 53 | |||
| 54 | * `func` the callback function to register | ||
| 55 | |||
| 56 | #### `public void `[`midi_register_aftertouch_callback`](#group__input__callback__reg_1gaa95bc901bd9edff956a667c9a69dd01f)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1gaa95bc901bd9edff956a667c9a69dd01f} | ||
| 57 | |||
| 58 | Register an after touch callback. | ||
| 59 | |||
| 60 | #### Parameters | ||
| 61 | * `device` the device associate with | ||
| 62 | |||
| 63 | * `func` the callback function to register | ||
| 64 | |||
| 65 | #### `public void `[`midi_register_pitchbend_callback`](#group__input__callback__reg_1ga071a28f02ba14f53de219be70ebd9a48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1ga071a28f02ba14f53de219be70ebd9a48} | ||
| 66 | |||
| 67 | Register a pitch bend callback. | ||
| 68 | |||
| 69 | #### Parameters | ||
| 70 | * `device` the device associate with | ||
| 71 | |||
| 72 | * `func` the callback function to register | ||
| 73 | |||
| 74 | #### `public void `[`midi_register_songposition_callback`](#group__input__callback__reg_1gaf2adfd79637f3553d8f26deb1ca22ed6)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1gaf2adfd79637f3553d8f26deb1ca22ed6} | ||
| 75 | |||
| 76 | Register a song position callback. | ||
| 77 | |||
| 78 | #### Parameters | ||
| 79 | * `device` the device associate with | ||
| 80 | |||
| 81 | * `func` the callback function to register | ||
| 82 | |||
| 83 | #### `public void `[`midi_register_progchange_callback`](#group__input__callback__reg_1gae6ba1a35a4cde9bd15dd42f87401d127)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1gae6ba1a35a4cde9bd15dd42f87401d127} | ||
| 84 | |||
| 85 | Register a program change callback. | ||
| 86 | |||
| 87 | #### Parameters | ||
| 88 | * `device` the device associate with | ||
| 89 | |||
| 90 | * `func` the callback function to register | ||
| 91 | |||
| 92 | #### `public void `[`midi_register_chanpressure_callback`](#group__input__callback__reg_1ga39b31f1f4fb93917ce039b958f21b4f5)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1ga39b31f1f4fb93917ce039b958f21b4f5} | ||
| 93 | |||
| 94 | Register a channel pressure callback. | ||
| 95 | |||
| 96 | #### Parameters | ||
| 97 | * `device` the device associate with | ||
| 98 | |||
| 99 | * `func` the callback function to register | ||
| 100 | |||
| 101 | #### `public void `[`midi_register_songselect_callback`](#group__input__callback__reg_1gaf9aafc76a2dc4b9fdbb4106cbda6ce72)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1gaf9aafc76a2dc4b9fdbb4106cbda6ce72} | ||
| 102 | |||
| 103 | Register a song select callback. | ||
| 104 | |||
| 105 | #### Parameters | ||
| 106 | * `device` the device associate with | ||
| 107 | |||
| 108 | * `func` the callback function to register | ||
| 109 | |||
| 110 | #### `public void `[`midi_register_tc_quarterframe_callback`](#group__input__callback__reg_1ga0a119fada2becc628cb15d753b257e6e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1ga0a119fada2becc628cb15d753b257e6e} | ||
| 111 | |||
| 112 | Register a tc quarter frame callback. | ||
| 113 | |||
| 114 | #### Parameters | ||
| 115 | * `device` the device associate with | ||
| 116 | |||
| 117 | * `func` the callback function to register | ||
| 118 | |||
| 119 | #### `public void `[`midi_register_realtime_callback`](#group__input__callback__reg_1ga764f440e857b89084b1a07f9da2ff93a)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` {#group__input__callback__reg_1ga764f440e857b89084b1a07f9da2ff93a} | ||
| 120 | |||
| 121 | Register a realtime callback. | ||
| 122 | |||
| 123 | The callback will be called for all of the real time message types. | ||
| 124 | |||
| 125 | #### Parameters | ||
| 126 | * `device` the device associate with | ||
| 127 | |||
| 128 | * `func` the callback function to register | ||
| 129 | |||
| 130 | #### `public void `[`midi_register_tunerequest_callback`](#group__input__callback__reg_1gae40ff3ce20bda79fef87da24b8321cb1)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` {#group__input__callback__reg_1gae40ff3ce20bda79fef87da24b8321cb1} | ||
| 131 | |||
| 132 | Register a tune request callback. | ||
| 133 | |||
| 134 | #### Parameters | ||
| 135 | * `device` the device associate with | ||
| 136 | |||
| 137 | * `func` the callback function to register | ||
| 138 | |||
| 139 | #### `public void `[`midi_register_sysex_callback`](#group__input__callback__reg_1ga63ce9631b025785c1848d0122d4c4c48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_sysex_func_t func)` {#group__input__callback__reg_1ga63ce9631b025785c1848d0122d4c4c48} | ||
| 140 | |||
| 141 | Register a sysex callback. | ||
| 142 | |||
| 143 | #### Parameters | ||
| 144 | * `device` the device associate with | ||
| 145 | |||
| 146 | * `func` the callback function to register | ||
| 147 | |||
| 148 | #### `public void `[`midi_register_fallthrough_callback`](#group__input__callback__reg_1ga7ed189164aa9682862b3181153afbd94)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` {#group__input__callback__reg_1ga7ed189164aa9682862b3181153afbd94} | ||
| 149 | |||
| 150 | Register fall through callback. | ||
| 151 | |||
| 152 | This is only called if a more specific callback is not matched and called. For instance, if you don't register a note on callback but you get a note on message the fall through callback will be called, if it is registered. | ||
| 153 | |||
| 154 | #### Parameters | ||
| 155 | * `device` the device associate with | ||
| 156 | |||
| 157 | * `func` the callback function to register | ||
| 158 | |||
| 159 | #### `public void `[`midi_register_catchall_callback`](#group__input__callback__reg_1ga9dbfed568d047a6cd05708f11fe39e99)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` {#group__input__callback__reg_1ga9dbfed568d047a6cd05708f11fe39e99} | ||
| 160 | |||
| 161 | Register a catch all callback. | ||
| 162 | |||
| 163 | If registered, the catch all callback is called for every message that is matched, even if a more specific or the fallthrough callback is registered. | ||
| 164 | |||
| 165 | #### Parameters | ||
| 166 | * `device` the device associate with | ||
| 167 | |||
| 168 | * `func` the callback function to register | ||
| 169 | |||
