[docs] Fix out-of-date documentation about channel events. Fixes #112

celtera · Aug 13, 2024 · f80673b · f80673b
1 parent 22d8697
commit f80673b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/book/src/file.md b/book/src/file.md
@@ -36,16 +36,16 @@ libremidi::writer writer;
 // Create tracks and events declaratively by changing the track vector directly:
 writer.tracks.push_back(
   libremidi::midi_track{
-    libremidi::track_event{0, 0, libremidi::message::note_on(1, 45, 35)},
-    libremidi::track_event{140, 0, libremidi::message::note_off(1, 45, 0)},
+    libremidi::track_event{0, 0, libremidi::channel_events::note_on(1, 45, 35)},
+    libremidi::track_event{140, 0, libremidi::channel_events::note_off(1, 45, 0)},
   }
 );
 
 // Or through a builder API:
 {
   int tick = 500;
   int track = 3;
-  libremidi::message msg = libremidi::message::note_on(1, 45, 35);
+  libremidi::message msg = libremidi::channel_events::note_on(1, 45, 35);
 
   // Tracks will be added as needed within safe limits
   writer.add_event(tick, track, msg);

diff --git a/book/src/midi-1-out.md b/book/src/midi-1-out.md
@@ -18,10 +18,10 @@ midi.send_message(bytes, sizeof(bytes));
 // This allows to pass std::vector, std::array and the likes
 midi.send_message(std::span<unsigned char>{ ... your span-compatible data-structure ... });
 
-// Option D: helpers with the libremidi::message class
+// Option D: helpers with the libremidi::channel_events and libremidi::meta_events structs
 // See libremidi/message.hpp for the full list
-midi.send_message(libremidi::message::note_on(channel, note, velocity));
-midi.send_message(libremidi::message::control_change(channel, control, value));
-midi.send_message(libremidi::message::pitch_bend(channel, value));
+midi.send_message(libremidi::channel_events::note_on(channel, note, velocity));
+midi.send_message(libremidi::channel_events::control_change(channel, control, value));
+midi.send_message(libremidi::channel_events::pitch_bend(channel, value));
 midi.send_message(libremidi::message{ /* a message */ });
 ```