Lomse library. API documentation  0.30.0
Tutorials and samples

In the Lomse repository, folder examples contains tutorials and sample code for using Lomse.

Tutorials

Tutorials are functional apps. that should be studied first. Apart from the source code each tutorial include a README.md file with a detailed step-by-step explanation of how the application is designed and coded, and about how Lomse works. It also includes instructions for building.

The name of the tutorials has a suffix for marking the environment/platform used by that code. The meaning of the suffix is as follows:

  • wx = wxWidgets framework (platform independent), e.g.: tutorial-1-wx.
  • qt = Qt framework (platform independent), e.g.: tutorial-1-qt.
  • x11 = For Linux with X11, e.g.: tutorial-1-x11.
  • win = For Microsoft Windows, e.g.: tutorial-1-win.

This is a list of available tutorials:

tutorial-1-xxx
Displaying a music score.
tutorial-2-xxx
Interacting with the score.
tutorial-3-xxx
Score playback.
tutorial-4-xxx
Visual tracking during playback.
wxMidi
This folder contains the sources for the wxMidi package. It is used in some tutorials and samples, for MIDI playback.

Samples

Samples are just minimal functional apps for highlighting how to do or to use some functionality, and they do not include normally any explanatory document, just a README.md file explaining the purpose of the sample. I created these samples for testing some functionality and for illustration purposes.

This is a list of available samples:

drawlines
Drawing marker lines on the score and removing them.
extplayer
Controlling scroll and the tempo line when using an external player.
transpose
An example for testing transposition commands.
viewtypes
A test for displaying and playing back scores using the different Lomse View types.