diff options
author | Jack Humbert <jack.humb@gmail.com> | 2018-03-26 14:24:30 -0400 |
---|---|---|
committer | skullydazed <skullydazed@users.noreply.github.com> | 2018-03-26 11:43:37 -0700 |
commit | ae7284edb8bd8ed7fcab29415049bf03baf57f8d (patch) | |
tree | b03927f750f03239a8e01837e29e8374dcd3ec1d /docs/internals_midi_device_setup_process.md | |
parent | 66162b2b681de37dd0aa34f3b6527a5292ab1560 (diff) | |
download | qmk_firmware-ae7284edb8bd8ed7fcab29415049bf03baf57f8d.tar.gz |
rename api docs to internals
Diffstat (limited to 'docs/internals_midi_device_setup_process.md')
-rw-r--r-- | docs/internals_midi_device_setup_process.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/internals_midi_device_setup_process.md b/docs/internals_midi_device_setup_process.md new file mode 100644 index 000000000..ae82197c5 --- /dev/null +++ b/docs/internals_midi_device_setup_process.md @@ -0,0 +1,31 @@ +# group `midi_device_setup_process` {#group__midi__device__setup__process} + +These are method that you must use to initialize and run a device. + +## Summary + + Members | Descriptions +--------------------------------|--------------------------------------------- +`public void `[`midi_device_init`](#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9)`(`[`MidiDevice`](#struct__midi__device)` * device)` | Initialize a device. +`public void `[`midi_device_process`](#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b)`(`[`MidiDevice`](#struct__midi__device)` * device)` | Process input data. + +## Members + +#### `public void `[`midi_device_init`](#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9} + +Initialize a device. + +You must call this before using the device in question. + +#### Parameters +* `device` the device to initialize + +#### `public void `[`midi_device_process`](#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b} + +Process input data. + +This method drives the input processing, you must call this method frequently if you expect to have your input callbacks called. + +#### Parameters +* `device` the device to process + |