docs/ikteam: Delete most files.
[haiku.git] / docs / user / midi2 / Midi2Defs.dox
blob778210ff1e8022d110c5d96d1c9ab79bfdb85f22
1 /*!
2         \file Midi2Defs.h
3         \ingroup midi2
4         \brief Some definitions to define raw MIDI events.
5 */
8 /*!
9         \name Channel Message Masks
10         \brief Some definitions to define the raw MIDI events.
12         The default implementation of BMidiLocalConsumer::Data() uses these
13         constants to determine which event has been passed on. If you override
14         that method, you may use the constants yourself.
18 //! @{
21 /*!
22         \var B_NOTE_OFF
26 /*!
27         \var B_NOTE_ON
31 /*!
32         \var B_KEY_PRESSURE
36 /*!
37         \var B_CONTROL_CHANGE
41 /*!
42         \var B_PROGRAM_CHANGE
46 /*!
47         \var B_CHANNEL_PRESSURE
51 /*!
52         \var B_PITCH_BEND
56 //! @}
59 /*!
60         \name System Messages
61         \brief Some definitions to define the raw MIDI system messages.
63         The default implementation of BMidiLocalConsumer::Data() uses these
64         constants to determine which event system message has been passed on.
65         See  BMidiLocalProducer::SpraySystemCommon() and
66         BMidiLocalProducer::SpraySystemRealTime() for more details on how and
67         when to use these messages.
71 //! @{
74 /*!
75         \var B_SYS_EX_START
79 /*!
80         \var B_MIDI_TIME_CODE
84 /*!
85         \var B_SONG_POSITION
89 /*!
90         \var B_SONG_SELECT
94 /*!
95         \var B_CABLE_MESSAGE
99 /*!
100         \var B_TUNE_REQUEST
105         \var B_SYS_EX_END
110         \var B_TIMING_CLOCK
115         \var B_START
120         \var B_CONTINUE
125         \var B_STOP
130         \var B_ACTIVE_SENSING
135         \var B_SYSTEM_RESET
139 //! @}
143         \name Controller Numbers
144         \brief Constants that represent specific controller messages.
146         These constants can be used in BMidiLocalProducer::SprayControlChange()
147         and BMidiLocalConsumer::ControlChange(). These constants represent the
148         MIDI specification.
152 //! @{
159         \var B_MODULATION
164         \var B_BREATH_CONTROLLER
169         \var B_FOOT_CONTROLLER
174         \var B_PORTAMENTO_TIME
179         \var B_DATA_ENTRY
184         \var B_MAIN_VOLUME
189         \var B_MIDI_BALANCE
194         \var B_PAN
199         \var B_EXPRESSION_CTRL
204         \var B_GENERAL_CTRL_1
209         \var B_GENERAL_CTRL_2
214         \var B_GENERAL_CTRL_3
219         \var B_GENERAL_CTRL_4
224         \var B_SUSTAIN_PEDAL
229         \var B_PORTAMENTO
234         \var B_SOSTENUTO
239         \var B_SOFT_PEDAL
244         \var B_HOLD_2
249         \var B_GENERAL_CTRL_5
254         \var B_GENERAL_CTRL_6
259         \var B_TEMPO_CHANGE
264         \var B_GENERAL_CTRL_7
269         \var B_GENERAL_CTRL_8
274         \var B_EFFECTS_DEPTH
279         \var B_TREMOLO_DEPTH
284         \var B_CHORUS_DEPTH
289         \var B_CELESTE_DEPTH
294         \var B_PHASER_DEPTH
299         \var B_DATA_INCREMENT
304         \var B_DATA_DECREMENT
309         \var B_RESET_ALL_CONTROLLERS
314         \var B_LOCAL_CONTROL
319         \var B_ALL_NOTES_OFF
324         \var B_OMNI_MODE_OFF
329         \var B_OMNI_MODE_ON
334         \var B_MONO_MODE_ON
339         \var B_POLY_MODE_ON
343 //! @}